Version 3.18.1
Show:

Promise.Resolver Class

Module: promise

Represents an asynchronous operation. Provides a standard API for subscribing to the moment that the operation completes either successfully (fulfill()) or unsuccessfully (reject()).

Constructor

Promise.Resolver

(
  • promise
)

Parameters:

  • promise Promise

    The promise instance this resolver will be handling

Item Index

Methods

Properties

Methods

_addCallbacks

(
  • [callback]
  • [errback]
)
private

Schedule execution of a callback to either or both of "resolve" and "reject" resolutions of this resolver. If the resolver is not pending, the correct callback gets called automatically.

Parameters:

  • [callback] Function optional

    function to execute if the Resolver resolves successfully

  • [errback] Function optional

    function to execute if the Resolver resolves unsuccessfully

_notify

(
  • subs
  • result
)
protected

Executes an array of callbacks from a specified context, passing a set of arguments.

Parameters:

  • subs Function[]

    The array of subscriber callbacks

  • result Any

    Value to pass the callbacks

fulfill

(
  • value
)

Resolves the promise, signaling successful completion of the represented operation. All "onFulfilled" subscriptions are executed and passed the value provided to this method. After calling fulfill(), reject() and notify() are disabled.

Parameters:

  • value Any

    Value to pass along to the "onFulfilled" subscribers

getStatus

() String deprecated

Returns the current status of the Resolver as a string "pending", "fulfilled", or "rejected".

Returns:

reject

(
  • value
)

Resolves the promise, signaling unsuccessful completion of the represented operation. All "onRejected" subscriptions are executed with the value provided to this method. After calling reject(), resolve() and notify() are disabled.

Parameters:

  • value Any

    Value to pass along to the "reject" subscribers

then

(
  • [callback]
  • [errback]
)
Promise deprecated

Schedule execution of a callback to either or both of "resolve" and "reject" resolutions for the Resolver. The callbacks are wrapped in a new Resolver and that Resolver's corresponding promise is returned. This allows operation chaining ala functionA().then(functionB).then(functionC) where functionA returns a promise, and functionB and functionC may return promises.

Parameters:

  • [callback] Function optional

    function to execute if the Resolver resolves successfully

  • [errback] Function optional

    function to execute if the Resolver resolves unsuccessfully

Returns:

Promise:

The promise of a new Resolver wrapping the resolution of either "resolve" or "reject" callback

Properties

_callbacks

Array private

List of success callbacks

_errbacks

Array private

List of failure callbacks

_result

Any private

This value that this promise represents.

_status

String private

The status of the operation. This property may take only one of the following values: 'pending', 'fulfilled' or 'rejected'.

Default: 'pending'

promise

Promise deprecated

The promise for this Resolver.