Class ExtendedPromise<T>

Wrapper of global.Promise class. Read more about Promises.

See

https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Promise

Type Parameters

  • T

Hierarchy (View Summary)

Implements

  • Promise<T>

Constructors

constructor

Methods

all allSettled any isPromise race reject resolve trackState withResolvers wrap catch else finally then trackState

Constructors

constructor

  • new ExtendedPromise<T>(
        executor: (
            resolve: (value: T | PromiseLike<T>) => void,
            reject: (reason?: any) => void,
        ) => void,
    ): ExtendedPromise<T>

  • Creates Promise instances.

    Type Parameters

    • T

    Parameters

    • executor: (
          resolve: (value: T | PromiseLike<T>) => void,
          reject: (reason?: any) => void,
      ) => void

      defined as (resolve,reject)=> {}

    Returns ExtendedPromise<T>

    Example

    new Promise((resolve, reject)=>{
         ...
    });
  • new ExtendedPromise<T>(
        promise: PromiseLike<T> | LegacyDojoDeferred,
        state: undefined | State,
        tag: typeof PRIVATE_CONSTRUCTOR_TAG,
    ): ExtendedPromise<T>

  • Internal constructor. Do not call.

    Type Parameters

    • T

    Parameters

    • promise: PromiseLike<T> | LegacyDojoDeferred
    • state: undefined | State
    • tag: typeof PRIVATE_CONSTRUCTOR_TAG

    Returns ExtendedPromise<T>

Methods

Staticall

  • all<T extends [] | readonly unknown[]>(
        iterable: T,
    ): ExtendedPromise<
        { -readonly [P in string
        | number
        | symbol]: Awaited<T[P<P>]> },
    >

  • Creates promise which fulfills if all other promises are fulfilled. Or rejects if one of the promises rejects.

    Type Parameters

    • T extends [] | readonly unknown[]

    Parameters

    • iterable: T

      Iterable of Promise instances

    Returns ExtendedPromise<{ -readonly [P in string | number | symbol]: Awaited<T[P<P>]> }>

StaticallSettled

  • allSettled<T>(
        iterable: Iterable<T | PromiseLike<T>>,
    ): ExtendedPromise<PromiseSettledResult<Awaited<T>>[]>

  • Creates a promise that resolves after all of the given promises have either fulfilled or rejected, with an array of objects that each describes the outcome of each promise.

    Type Parameters

    • T

    Parameters

    • iterable: Iterable<T | PromiseLike<T>>

      Iterable of Promise instances

    Returns ExtendedPromise<PromiseSettledResult<Awaited<T>>[]>

Staticany

  • any<T>(
        iterable: (T | PromiseLike<T>)[] | Iterable<T | PromiseLike<T>>,
    ): ExtendedPromise<T>

  • Promise.any() takes an iterable of Promise objects and, as soon as one of the promises in the iterable fulfills, returns a single promise that resolves with the value from that promise. If no promises in the iterable fulfill (if all of the given promises are rejected), then the returned promise is rejected with an AggregateError, Essentially, this method is the opposite of Promise.all().

    Type Parameters

    • T

    Parameters

    • iterable: (T | PromiseLike<T>)[] | Iterable<T | PromiseLike<T>>

      Iterable of Promise instances

    Returns ExtendedPromise<T>

StaticisPromise

  • isPromise(candidate: any): candidate is PromiseLike<unknown>

  • This method tests if a given object is a promise. The algorithm will return true for:

    • apprt-core/Promise
    • global Promise
    • dojo/Deferred
    • dojo/Deferred.promise

    Note: Because of support for dojo/Deferred any object with a 'then', 'isResolved' and 'isRejected' method is detected as a promise.

    Parameters

    • candidate: any

      a potential promise.

    Returns candidate is PromiseLike<unknown>

    true if candidate is a promise.

Staticrace

  • race<T>(
        iterable: Iterable<T>,
    ): ExtendedPromise<T extends PromiseLike<U> ? U : T>

  • Creates promise which fulfills if one of the other promises fulfills. Or rejects if one of the promises rejects.

    Type Parameters

    • T

    Parameters

    • iterable: Iterable<T>

      Iterable of Promise instances

    Returns ExtendedPromise<T extends PromiseLike<U> ? U : T>

  • race<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T>

  • Creates promise which fulfills if one of the other promises fulfills. Or rejects if one of the promises rejects.

    Type Parameters

    • T

    Parameters

    • iterable: Iterable<T | PromiseLike<T>>

      Iterable of Promise instances

    Returns ExtendedPromise<T>

Staticreject

  • reject<T = never>(reason?: any): ExtendedPromise<T>

  • Type Parameters

    • T = never

    Parameters

    • Optionalreason: any

      The reason the promise was rejected.

    Returns ExtendedPromise<T>

    a promise in rejected state.

Staticresolve

  • resolve(): ExtendedPromise<void>

  • Creates a new resolved promise

    Returns ExtendedPromise<void>

  • resolve<T>(value: T): ExtendedPromise<T>

  • Creates a new resolved promise with the given value

    Type Parameters

    • T

    Parameters

    • value: T

      result object.

    Returns ExtendedPromise<T>

    a promise in fulfilled state.

StatictrackState

StaticwithResolvers

  • withResolvers<T>(): {
        promise: ExtendedPromise<T>;
        reject: (reason?: unknown) => void;
        resolve: (value: T | PromiseLike<T>) => void;
    }

  • Produces an object with a promise along with its resolution and rejection functions. Allows to resolve/reject the promise manually after creating it.

    Type Parameters

    • T

    Returns {
        promise: ExtendedPromise<T>;
        reject: (reason?: unknown) => void;
        resolve: (value: T | PromiseLike<T>) => void;
    }

    Example

    const { promise, resolve, reject } = Promise.withResolvers();

Staticwrap

  • wrap<T>(promise: LegacyDojoDeferred | PromiseLike<T>): ExtendedPromise<T>

  • Wraps e.g. dojo/Deferred or native Promise to this Promise class.

    Type Parameters

    • T

    Parameters

    • promise: LegacyDojoDeferred | PromiseLike<T>

    Returns ExtendedPromise<T>

    a promise

catch

else

  • else<TResult = never>(
        failure?: null | (reason: any) => TResult | PromiseLike<TResult>,
    ): ExtendedPromise<T | TResult>

  • Registers an error handler. Which is not called if the error is a Cancel instance.

    Type Parameters

    • TResult = never

    Parameters

    • Optionalfailure: null | (reason: any) => TResult | PromiseLike<TResult>

      called when the promise rejects

    Returns ExtendedPromise<T | TResult>

finally

  • finally(handler?: null | () => void): ExtendedPromise<T>

  • Registers a handler, which is called in success or error state. But the handler is not able to change the result state!

    Parameters

    • Optionalhandler: null | () => void

      function invoked regardless of success or error

    Returns ExtendedPromise<T>

then

trackState

Settings

Member Visibility

On This Page

Constructors
Methods