* added reference for JS Client * added reference for JS Client * added reference for JS Client
6.3 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Interface: PromiseConstructor
internal.PromiseConstructor
Properties
[species]
• Readonly [species]: PromiseConstructor
Defined in
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:178
prototype
• Readonly prototype: Promise<any>
A reference to the prototype.
Defined in
node_modules/typescript/lib/lib.es2015.promise.d.ts:25
Methods
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
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
values |
Iterable<T | PromiseLike<T>> |
An iterable of Promises. |
Returns
A new Promise.
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:226
▸ all<T>(values): 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
| Name | Type |
|---|---|
T |
extends readonly unknown[] | [] |
Parameters
| Name | Type | Description |
|---|---|---|
values |
T |
An array of Promises. |
Returns
Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
A new Promise.
Defined in
node_modules/typescript/lib/lib.es2015.promise.d.ts:41
allSettled
▸ allSettled<T>(values): 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
| Name | Type |
|---|---|
T |
extends readonly unknown[] | [] |
Parameters
| Name | Type | Description |
|---|---|---|
values |
T |
An array of Promises. |
Returns
Promise<{ -readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P]>> }>
A new Promise.
Defined in
node_modules/typescript/lib/lib.es2020.promise.d.ts:40
▸ 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
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
values |
Iterable<T | PromiseLike<T>> |
An array of Promises. |
Returns
Promise<PromiseSettledResult<Awaited<T>>[]>
A new Promise.
Defined in
node_modules/typescript/lib/lib.es2020.promise.d.ts:48
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
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
values |
Iterable<T | PromiseLike<T>> |
An iterable of Promises. |
Returns
A new Promise.
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:234
▸ 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
| Name | Type |
|---|---|
T |
extends readonly unknown[] | [] |
Parameters
| Name | Type | Description |
|---|---|---|
values |
T |
An array of Promises. |
Returns
A new Promise.
Defined in
node_modules/typescript/lib/lib.es2015.promise.d.ts:52
reject
▸ reject<T>(reason?): Promise<T>
Creates a new rejected promise for the provided reason.
Type parameters
| Name | Type |
|---|---|
T |
never |
Parameters
| Name | Type | Description |
|---|---|---|
reason? |
any |
The reason the promise was rejected. |
Returns
Promise<T>
A new rejected Promise.
Defined in
node_modules/typescript/lib/lib.es2015.promise.d.ts:62
resolve
▸ resolve(): Promise<void>
Creates a new resolved promise.
Returns
Promise<void>
A resolved promise.
Defined in
node_modules/typescript/lib/lib.es2015.promise.d.ts:68
▸ resolve<T>(value): Promise<T>
Creates a new resolved promise for the provided value.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
value |
T | PromiseLike<T> |
A promise. |
Returns
Promise<T>
A promise whose internal state matches the provided promise.
Defined in
node_modules/typescript/lib/lib.es2015.promise.d.ts:75