Class Subscription

constructor

• new Subscription(executor): Subscription

• Creates a new Promise.

  Parameters

  • executor: ((resolve, reject) => void)

    A callback used to initialize the promise. This callback is passed two arguments: a resolve callback used to resolve the promise with a value or the result of another promise, and a reject callback used to reject the promise with a provided reason or error.

    • • (resolve, reject): void

      • Parameters

        • resolve: ((value) => void)
          • • (value): void

            • Parameters

              • value: void | PromiseLike<void>

              Returns void

        • reject: ((reason?) => void)
          • • (reason?): void

            • Parameters

              • Optional reason: any

              Returns void

        Returns void

  Returns Subscription

Readonly [toStringTag]

Static Readonly [species]

catch

• catch<TResult>(onrejected?): Promise<void | 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<void | TResult>

  A Promise for the completion of the callback.

finally

• finally(onfinally?): Promise<void>

• 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<void>

  A Promise for the completion of the callback.

then

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

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

  Type Parameters

  • TResult1 = void
  • TResult2 = never

  Parameters

  • Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)

    The callback to execute when the Promise is resolved.
  • Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

    The callback to execute when the Promise is rejected.

  Returns Promise<TResult1 | TResult2>

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

Static all

• all<T>(values): Promise<Awaited<T>[]>

• Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

  Type Parameters

  • T

  Parameters

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

    An iterable of Promises.

  Returns Promise<Awaited<T>[]>

  A new Promise.
• all<T>(values): Promise<{
      -readonly [P in string | number | symbol]: Awaited<T[P<P>]>
  }>

• Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

  Type Parameters

  • T extends [] | readonly unknown[]

  Parameters

  • values: T

    An array of Promises.

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

  A new Promise.

Static allSettled

• allSettled<T>(values): Promise<{
      -readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P<P>]>>
  }>

• Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.

  Type Parameters

  • T extends [] | readonly unknown[]

  Parameters

  • values: T

    An array of Promises.

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

  A new Promise.
• allSettled<T>(values): Promise<PromiseSettledResult<Awaited<T>>[]>

• Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.

  Type Parameters

  • T

  Parameters

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

    An array of Promises.

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

  A new Promise.

Static any

• any<T>(values): Promise<Awaited<T[number]>>

• The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

  Type Parameters

  • T extends [] | readonly unknown[]

  Parameters

  • values: T

    An array or iterable of Promises.

  Returns Promise<Awaited<T[number]>>

  A new Promise.
• any<T>(values): Promise<Awaited<T>>

• The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

  Type Parameters

  • T

  Parameters

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

    An array or iterable of Promises.

  Returns Promise<Awaited<T>>

  A new Promise.

Static race

• race<T>(values): Promise<Awaited<T>>

• Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

  Type Parameters

  • T

  Parameters

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

    An iterable of Promises.

  Returns Promise<Awaited<T>>

  A new Promise.
• race<T>(values): Promise<Awaited<T[number]>>

• Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

  Type Parameters

  • T extends [] | readonly unknown[]

  Parameters

  • values: T

    An array of Promises.

  Returns Promise<Awaited<T[number]>>

  A new Promise.

Static reject

• reject<T>(reason?): Promise<T>

• Creates a new rejected promise for the provided reason.

  Type Parameters

  • T = never

  Parameters

  • Optional reason: any

    The reason the promise was rejected.

  Returns Promise<T>

  A new rejected Promise.

Static resolve

• resolve(): Promise<void>

• Creates a new resolved promise.

  Returns Promise<void>

  A resolved promise.
• resolve<T>(value): Promise<Awaited<T>>

• Creates a new resolved promise for the provided value.

  Type Parameters

  • T

  Parameters

  • value: T

    A promise.

  Returns Promise<Awaited<T>>

  A promise whose internal state matches the provided promise.
• resolve<T>(value): Promise<Awaited<T>>

• Creates a new resolved promise for the provided value.

  Type Parameters

  • T

  Parameters

  • value: T | PromiseLike<T>

    A promise.

  Returns Promise<Awaited<T>>

  A promise whose internal state matches the provided promise.