AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    Promise.Resolver Class

    Defined in: yui3/src/promise/js/resolver.js:1
    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
    )

    Defined in yui3/src/promise/js/resolver.js:1

    Parameters:

    • promise Promise

      The promise instance this resolver will be handling

    Index

    Methods

    Properties

    Methods

    _addCallbacks

    (
    • [callback]
    • [errback]
    )
    private

    Defined in yui3/src/promise/js/resolver.js:178

    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

    Defined in yui3/src/promise/js/resolver.js:225

    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
    )

    Defined in yui3/src/promise/js/resolver.js:60

    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

    Defined in yui3/src/promise/js/resolver.js:212

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

    Returns:

    String:

    reject

    (
    • value
    )

    Defined in yui3/src/promise/js/resolver.js:92

    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

    Defined in yui3/src/promise/js/resolver.js:157

    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

    Defined in yui3/src/promise/js/resolver.js:11

    List of success callbacks

    _errbacks

    Array private

    Defined in yui3/src/promise/js/resolver.js:20

    List of failure callbacks

    _result

    Any private

    Defined in yui3/src/promise/js/resolver.js:49

    This value that this promise represents.

    _status

    String private

    Defined in yui3/src/promise/js/resolver.js:38

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

    Default: 'pending'

    promise

    Promise deprecated

    Defined in yui3/src/promise/js/resolver.js:29

    The promise for this Resolver.