Class ProgressRealmPromise

Implements

Properties

catch finally then

Accessors

[toStringTag]

Methods

cancel progress

Properties

catch

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

Type declaration

    • <TResult>(onrejected?): Promise<export= | TResult>

    • Attaches a callback for only the rejection of the Promise.

      Type Parameters

      • TResult = never

      Parameters

      • Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)

        The callback to execute when the Promise is rejected.

      Returns Promise<export= | TResult>

      A Promise for the completion of the callback.

finally

finally: ((onfinally?) => Promise<export=>) = ...

Type declaration

    • (onfinally?): Promise<export=>

    • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

      Parameters

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

        The callback to execute when the Promise is settled (fulfilled or rejected).

      Returns Promise<export=>

      A Promise for the completion of the callback.

then

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

Type declaration

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

    • Attaches callbacks for the resolution and/or rejection of the Promise.

      Type Parameters

      Parameters

      Returns Promise<TResult1 | TResult2>

      A Promise for the completion of which ever callback is executed.

Accessors

[toStringTag]

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

Member Visibility

Theme

On This Page

Generated using TypeDoc