Class ProgressRealmPromise

Implements

Constructors

constructor

Properties

cancelAndResetTask catch createTimeoutPromise emitProgress finally rejectAsCanceled then

Accessors

[toStringTag]

Methods

cancel progress

Constructors

constructor

Properties

Private cancelAndResetTask

cancelAndResetTask: any

catch

catch: (<TResult>(onrejected?) => Promise<Realm | TResult>)

Type declaration

Private createTimeoutPromise

createTimeoutPromise: any

Private emitProgress

emitProgress: any

finally

finally: ((onfinally?) => Promise<Realm>)

Type declaration

    • (onfinally?): Promise<Realm>

    • Parameters

      • Optional onfinally: null | (() => void)

      Returns Promise<Realm>

Private rejectAsCanceled

rejectAsCanceled: any

then

then: (<TResult1, TResult2>(onfulfilled?, onrejected?) => Promise<TResult1 | TResult2>)

Type declaration

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

Methods

cancel

  • cancel(): void

  • Cancels the download of the Realm If multiple ProgressRealmPromise instances are in progress for the same Realm, then canceling one of them will cancel all of them.

    Returns void

progress

  • progress(callback): this

  • Register to receive progress notifications while the download is in progress.

    Parameters

    • callback: ProgressNotificationCallback

      Called multiple times as the client receives data, with two arguments:

      1. transferred The current number of bytes already transferred
      2. transferable The total number of transferable bytes (i.e. the number of bytes already transferred plus the number of bytes pending transfer)

    Returns this

Settings

Theme

On This Page

Generated using TypeDoc