Class DeferredPromise<T>

Deferred promise implementation.

Type Parameters

Implements

Promise<T>

Index

Constructors

constructor

new DeferredPromise<T>(promise?: Promise<T>): DeferredPromise<T>
Create a new deferrable promise which supports resolving it outside of the context of the promise.
Type Parameters
- T
Parameters
- Optionalpromise: Promise<T>
  Optionally a promise to wrap.
Returns DeferredPromise<T>
- Defined in packages/util/src/deferred.ts:22

Properties

`Private`#innerPromise

"#innerPromise": Promise<T>

`Private`#isResolved

"#isResolved": boolean = false

`Private`#reject

"#reject": (err: any) => void

`Private`#resolve

"#resolve": (result: T | Promise<T>) => void

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Implementation of Promise.[toStringTag]
- Defined in packages/util/src/deferred.ts:10

isResolved

get isResolved(): boolean
Returns boolean
- Defined in packages/util/src/deferred.ts:14

Methods

bind

bind(other: Promise<T>): DeferredPromise<T>
Bind the current promise to another promise, resolving or rejecting the current promise when the other promise is resolved or rejected.
Parameters
- other: Promise<T>
  The other promise to bind to.
Returns DeferredPromise<T>
The current promise.
- Defined in packages/util/src/deferred.ts:35

catch

catch<TResult = never>(
onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: (reason: any) => TResult | PromiseLike<TResult>
  The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>
A Promise for the completion of the callback.
Implementation of Promise.catch
- Defined in packages/util/src/deferred.ts:69

finally

finally(onFinally?: () => void): 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
Returns Promise<T>
A Promise for the completion of the callback.
Implementation of Promise.finally
- Defined in packages/util/src/deferred.ts:73

reject

reject(err: any): void
Parameters
- err: any
Returns void
- Defined in packages/util/src/deferred.ts:49

reset

reset(): void
Returns void
- Defined in packages/util/src/deferred.ts:41

resolve

resolve(result: T | Promise<T>): void
Parameters
- result: T | Promise<T>
Returns void
- Defined in packages/util/src/deferred.ts:57

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>,
onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
): 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>
  The callback to execute when the Promise is resolved.
- Optionalonrejected: (reason: any) => 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.
Implementation of Promise.then
- Defined in packages/util/src/deferred.ts:65

Class DeferredPromise<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DeferredPromise<T>

Properties

Private#innerPromise

Private#isResolved

Private#reject

Private#resolve

Accessors

[toStringTag]

Returns string

isResolved

Returns boolean

Methods

bind

Parameters

Returns DeferredPromise<T>

catch

Type Parameters

Parameters

Returns Promise<T | TResult>

finally

Parameters

Returns Promise<T>

reject

Parameters

Returns void

reset

Returns void

resolve

Parameters

Returns void

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

Settings

On This Page

`Private`#innerPromise

`Private`#isResolved

`Private`#reject

`Private`#resolve