Class Deferred<T>

A Deferred object represents a value that may not be available yet but will be resolved or rejected in the future.

Type Parameters

T

Index

Constructors

Accessors

isFinalized isPending isRejected isResolved promise state

Methods

Constructors

constructor

new Deferred<T>(): Deferred<T>
Creates a new Deferred object.
Type Parameters
- T
Returns Deferred<T>
- Defined in src/common/Deferred.ts:90

Accessors

isFinalized

get isFinalized(): boolean
Checks if the Deferred object has been finalized (either resolved or rejected).

Returns boolean
- Defined in src/common/Deferred.ts:69

isPending

get isPending(): boolean
Checks if the Deferred object is still pending.

Returns boolean
- Defined in src/common/Deferred.ts:62

isRejected

get isRejected(): boolean
Checks if the Deferred object has been rejected.

Returns boolean
- Defined in src/common/Deferred.ts:83

isResolved

get isResolved(): boolean
Checks if the Deferred object has been resolved.

Returns boolean
- Defined in src/common/Deferred.ts:76

promise

get promise(): Promise<T>
The promise associated with this Deferred object. It can be used to wait for the value to be resolved or rejected.

Returns Promise<T>
- Defined in src/common/Deferred.ts:40
set promise(promise: Promise<T>): void
Parameters
- promise: Promise<T>
Returns void
- Defined in src/common/Deferred.ts:44

state

get state(): DeferredState
The current state of the Deferred object.

Returns DeferredState
- Defined in src/common/Deferred.ts:51
set state(state: DeferredState): void
Parameters
- state: DeferredState
Returns void
- Defined in src/common/Deferred.ts:55

Methods

reject

reject(reason?: unknown): void
Rejects the Deferred object with an optional reason. If the Deferred object has already been resolved or rejected, this method does nothing.
Parameters
- Optionalreason: unknown
  The reason for rejection (optional).
Returns void
- Defined in src/common/Deferred.ts:118

resolve

resolve(value: T): void
Resolves the Deferred object with a value. If the Deferred object has already been resolved or rejected, this method does nothing.
Parameters
- value: T
  The value to resolve the Deferred object with.
Returns void
- Defined in src/common/Deferred.ts:105