Class Deferred<T>

A deferred promise implementation that allows external resolution/rejection

Type Parameters

T = void

Index

Constructors

Properties

promise reject resolve

Accessors

isPending isRejected isResolved isSettled rejectReason

Methods

Constructors

constructor

new Deferred<T = void>(): Deferred<T>
Type Parameters
- T = void
Returns Deferred<T>
- Defined in helpers/internal/Deferred.ts:13

Properties

`Readonly`promise

promise: Promise<T>

reject

reject: (reason?: any) => void

resolve

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

Accessors

isPending

get isPending(): boolean
Returns true if the promise is still pending

Returns boolean
- Defined in helpers/internal/Deferred.ts:52

isRejected

get isRejected(): boolean
Returns true if the promise has been rejected

Returns boolean
- Defined in helpers/internal/Deferred.ts:41

isResolved

get isResolved(): boolean
Returns true if the promise has been resolved

Returns boolean
- Defined in helpers/internal/Deferred.ts:34

isSettled

get isSettled(): boolean
Returns true if the promise has been settled (resolved or rejected)

Returns boolean
- Defined in helpers/internal/Deferred.ts:59

rejectReason

get rejectReason(): unknown
Returns unknown
- Defined in helpers/internal/Deferred.ts:45

Methods

step

step<TResult2 = never>(): [
    onfulfilled?: ((value: T) => T | PromiseLike<T>)
    | null,
    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
]
Type Parameters
- TResult2 = never
Returns [
    onfulfilled?: ((value: T) => T | PromiseLike<T>)
    | null,
    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
]
- Defined in helpers/internal/Deferred.ts:63

`Static`Derive

Derive<T>(promise: Promise<T>): Deferred<T>
Type Parameters
- T
Parameters
- promise: Promise<T>
Returns Deferred<T>
- Defined in helpers/internal/Deferred.ts:77