Class DeferredPromise<ResolveType, RejectType>

Type Parameters

ResolveType = unknown
RejectType = unknown

Hierarchy

Promise<ResolveType>
- DeferredPromise

Index

Constructors

constructor

new DeferredPromise<ResolveType, RejectType>(executor?): DeferredPromise<ResolveType, RejectType>
Type Parameters
- ResolveType = unknown
- RejectType = unknown
Parameters
- executor: ((resolve, reject) => void) = ...
  - - (resolve, reject): void
    - Parameters
      resolve: ((value) => void)
      (value): void
      Parameters
      value: ResolveType | PromiseLike<ResolveType>
      Returns void
      reject: ((reason?) => void)
      (reason?): void
      Parameters
      Optional reason: any
      Returns void
      Returns void
Returns DeferredPromise<ResolveType, RejectType>
Overrides Promise<ResolveType>.constructor
- Defined in src/lib/DeferredPromise.ts:10

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Private` _isDone

_isDone: boolean = false

`Private` constructorStackString

constructorStackString: string

`Private` initialCallStack

initialCallStack: undefined | string

`Private` rejectHandler

rejectHandler: ((error) => void)

Type declaration

- (error): void
- Parameters
  - error: RejectType
  Returns void

`Private` resolveHandler

resolveHandler: ((value) => void)

Type declaration

- (value): void
- Parameters
  - value: ResolveType | PromiseLike<ResolveType>
  Returns void

`Static` `Readonly` [species]

[species]: PromiseConstructor

Accessors

isDone

get isDone(): boolean
Whether the promise has been resolved or rejected.

Returns boolean
- Defined in src/lib/DeferredPromise.ts:34

Methods

`Private` buildErrorStack

buildErrorStack(error, currentCaller): void
Parameters
- error: Error
- currentCaller: undefined | string
Returns void
- Defined in src/lib/DeferredPromise.ts:73

catch

catch<TResult>(onrejected?): Promise<ResolveType | 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<ResolveType | TResult>
A Promise for the completion of the callback.
Inherited from Promise.catch
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es5.d.ts:1557

finally

finally(onfinally?): Promise<ResolveType>
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<ResolveType>
A Promise for the completion of the callback.
Inherited from Promise.finally
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2018.promise.d.ts:29

`Private` getStackAtLines

getStackAtLines(stack): {
atLines: string[];
head: string[];
}
Parameters
- stack: string
Returns {
atLines: string[];
head: string[];
}
- atLines: string[]
- head: string[]
- Defined in src/lib/DeferredPromise.ts:85

reject

reject(rejectValue): void
Reject the promise with a value.
Parameters
- rejectValue: RejectType
Returns void
- Defined in src/lib/DeferredPromise.ts:52

resolve

resolve(resolveValue): void
Resolve the promise with a value.
Parameters
- resolveValue: ResolveType | PromiseLike<ResolveType>
Returns void
- Defined in src/lib/DeferredPromise.ts:41

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = ResolveType
- 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.
Inherited from Promise.then
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es5.d.ts:1550

`Private` updateErrorStack

updateErrorStack(error, stack): void
Parameters
- error: Error
- stack: string
Returns void
- Defined in src/lib/DeferredPromise.ts:78

`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.
Inherited from Promise.all
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:225
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
- 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 Promise.all
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:39

`Static` 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
- 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 Promise.allSettled
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2020.promise.d.ts:38
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.
Inherited from Promise.allSettled
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2020.promise.d.ts:46

`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.
Inherited from Promise.any
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2021.promise.d.ts:40
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.
Inherited from Promise.any
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2021.promise.d.ts:47

`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.
Inherited from Promise.race
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:233
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.
Inherited from Promise.race
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:50

`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.
Inherited from Promise.reject
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:60

`Static` resolve

resolve(): Promise<void>
Creates a new resolved promise.

Returns Promise<void>
A resolved promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:66
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.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:72
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.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:78

Class DeferredPromise<ResolveType, RejectType>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Parameters

Parameters

Returns void

Parameters

Returns void

Returns void

Returns DeferredPromise<ResolveType, RejectType>

Properties

Readonly [toStringTag]

Private _isDone

Private constructorStackString

Private initialCallStack

Private rejectHandler

Type declaration

Parameters

Returns void

Private resolveHandler

Type declaration

Parameters

Returns void

Static Readonly [species]

Accessors

isDone

Returns boolean

Methods

Private buildErrorStack

Parameters

Returns void

catch

Type Parameters

Parameters

Returns Promise<ResolveType | TResult>

finally

Parameters

Returns Promise<ResolveType>

Private getStackAtLines

Parameters

Returns { atLines: string[]; head: string[]; }

atLines: string[]

head: string[]

reject

Parameters

Returns void

resolve

Parameters

Returns void

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

Private updateErrorStack

Parameters

Returns void

Static all

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

Type Parameters

Parameters

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

Static allSettled

Type Parameters

Parameters

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

Type Parameters

Parameters

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

Static any

`Readonly` [toStringTag]

`Private` _isDone

`Private` constructorStackString

`Private` initialCallStack

`Private` rejectHandler

`Private` resolveHandler

`Static` `Readonly` [species]

`Private` buildErrorStack

`Private` getStackAtLines

Returns {
atLines: string[];
head: string[];
}

`Private` updateErrorStack

`Static` all

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

`Static` allSettled

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

`Static` any

`Static` race

`Static` reject

`Static` resolve