Class Deferred<T>

A Deferred object is a Promise with public methods to resolve and reject.

Example:

 const deferred = new Deferred<number>()
 setTimeout(() => {
     deferred.resolve(42)
 }, 1000)

 deferred.then(value => console.log('Resolved to:', value))

Type Parameters

Implements

Promise<T>

Index

Constructors

constructor

new Deferred<T>(): Deferred<T>
Type Parameters
- T
Returns Deferred<T>
- Defined in util/async/Deferred.ts:24

Properties

reject

reject: (reason?: any) => void

resolve

resolve: (value: T | PromiseLike<T>) => void

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Implementation of Promise.[toStringTag]
- Defined in util/async/Deferred.ts:48

Methods

catch

catch<TResult = never>(
onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>),
): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: null | ((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 util/async/Deferred.ts:31

finally

finally(onfinally?: null | (() => 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: null | (() => void)
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>
A Promise for the completion of the callback.
Implementation of Promise.finally
- Defined in util/async/Deferred.ts:44

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>),
onrejected?: null | ((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: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
  The callback to execute when the Promise is resolved.
- Optionalonrejected: null | ((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 util/async/Deferred.ts:37

Class Deferred<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns Deferred<T>

Properties

reject

resolve

Accessors

[toStringTag]

Returns string

Methods

catch

Type Parameters

Parameters

Returns Promise<T | TResult>

finally

Parameters

Returns Promise<T>

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

Settings

On This Page