Class Promise<T>

The Promise class is a subclass of the global Promise class that adds the ability to resolve or reject the promise from outside of the executor function.

Type Parameters

Hierarchy (View Summary)

Promise<T>
- Promise
  - AsyncResult

Index

Constructors

constructor

new Promise<T>(
    executor?: (
        resolve: (value: T | PromiseLike<T>) => void,
        reject: (reason: any) => void,
    ) => void,
): Promise<T>
Constructs a new promise.
Type Parameters
- T
Parameters
- Optionalexecutor: (
  resolve: (value: T | PromiseLike<T>) => void,
  reject: (reason: any) => void,
  ) => void
  The executor function that is called immediately when the promise is constructed. It is passed two functions, resolve and reject, that can be called to resolve or reject the promise respectively.
Returns Promise<T>

Overrides globalThis.Promise<T>.constructor

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": PromiseConstructor

Methods

catch

catch<TResult = never>(
onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: ((reason: any) => TResult | PromiseLike<TResult>) | null
  The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>
A Promise for the completion of the callback.

Inherited from globalThis.Promise.catch

finally

finally(onfinally?: (() => void) | null): Promise<T>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- Optionalonfinally: (() => void) | null
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>
A Promise for the completion of the callback.

Inherited from globalThis.Promise.finally

reject

reject(reason: any): void
Rejects the promise with the specified reason.
Parameters
- reason: any
  The reason for rejecting the promise.
Returns void

resolve

resolve(value?: T | PromiseLike<T>): void
Resolves the promise with the specified value.
Parameters
- Optionalvalue: T | PromiseLike<T>
  The value to resolve the promise with.
Returns void

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | null
  The callback to execute when the Promise is resolved.
- Optionalonrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.

Inherited from globalThis.Promise.then

`Static`all

all<T>(values: Iterable<T | PromiseLike<T>>): 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.

Inherited from globalThis.Promise.all
all<T extends [] | readonly unknown[]>(
values: T,
): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[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]> }>
A new Promise.

Inherited from globalThis.Promise.all

`Static`allSettled

allSettled<T extends [] | readonly unknown[]>(
    values: T,
): Promise<
    {
        -readonly [P in string
        | number
        | symbol]: PromiseSettledResult<Awaited<T[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]>>
    },
>
A new Promise.

Inherited from globalThis.Promise.allSettled
allSettled<T>(
values: Iterable<T | PromiseLike<T>>,
): 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.

Inherited from globalThis.Promise.allSettled

`Static`delay

delay(ms: number): Promise<void>
Returns a promise that is resolved after a specified delay.
Parameters
- ms: number
  The number of milliseconds to delay.
Returns Promise<void>
A promise that is resolved after the specified delay.
delay<T>(ms: number, value: T): Promise<T>
Returns a promise that is resolved after a specified delay with a specified value.
Type Parameters
- T
Parameters
- ms: number
  The number of milliseconds to delay.
- value: T
  The value to resolve the promise with.
Returns Promise<T>
A promise that is resolved after the specified delay with the specified value.

`Static`race

race<T>(values: Iterable<T | PromiseLike<T>>): 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.

Inherited from globalThis.Promise.race
race<T extends [] | readonly unknown[]>(values: T): 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.

Inherited from globalThis.Promise.race

`Static`reject

reject<T = never>(reason?: any): Promise<T>
Creates a new rejected promise for the provided reason.
Type Parameters
- T = never
Parameters
- Optionalreason: any
  The reason the promise was rejected.
Returns Promise<T>
A new rejected Promise.

Inherited from globalThis.Promise.reject

`Static`resolve

resolve(): Promise<void>

Creates a new resolved promise.

Returns Promise<void>
A resolved promise.

Inherited from globalThis.Promise.resolve
resolve<T>(value: T): 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.

Inherited from globalThis.Promise.resolve
resolve<T>(value: T | PromiseLike<T>): 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.

Inherited from globalThis.Promise.resolve

Class Promise<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Promise<T>

Properties

Readonly[toStringTag]

Static Readonly[species]

Methods

catch

Type Parameters

Parameters

Returns Promise<T | TResult>

finally

Parameters

Returns Promise<T>

reject

Parameters

Returns void

resolve

Parameters

Returns void

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

Staticall

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

Type Parameters

Parameters

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

StaticallSettled

Type Parameters

Parameters

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

Type Parameters

Parameters

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

Staticdelay

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Staticrace

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Staticreject

Type Parameters

Parameters

Returns Promise<T>

Staticresolve

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Settings

On This Page

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Static`all

`Static`allSettled

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

`Static`delay

`Static`race

`Static`reject

`Static`resolve