Class PromiseResolutionSource<T>

Resolves or rejects a Promise from outside of it.

This class is similar to Deferred but it explicitly separates the promise and its control side into two different objects.

see: PromiseLikeResolutionSource

Type parameters

T

type of the promise resolution result.

Hierarchy

PromiseResolutionSource

Index

Accessors

promise

Methods

Accessors

promise

get promise(): Promise<T>

- Defined in packages/tasklike-promise-library/src/primitives/promiseResolutionSource.ts:34
Gets the derived Promise controlled by the current instance.

Returns Promise<T>

Methods

tryCancel

tryCancel(): boolean

- Defined in packages/tasklike-promise-library/src/primitives/promiseResolutionSource.ts:58
Cancels the derived Promise.

Returns boolean

true if the derived Promise has just been rejected with PromiseCancelledError; otherwise it means the Promise has already been settled before.

tryReject

tryReject(reason: any): boolean

- Defined in packages/tasklike-promise-library/src/primitives/promiseResolutionSource.ts:73
Rejects the derived Promise with the specified rason.

Parameters
- reason: any
  
  the rejection reason, or the Error causing the rejection.
Returns boolean

true if the derived Promise has just been rejected; otherwise it means the Promise has already been settled before.

tryResolve

tryResolve(result: T | PromiseLike<T>): boolean

- Defined in packages/tasklike-promise-library/src/primitives/promiseResolutionSource.ts:44
Resolves the derived Promise with the specified result.

Parameters
- result: T | PromiseLike<T>
  
  the resolution result, or a PromiseLike that can be furtherly resolved.
Returns boolean

true if the derived Promise has just been resolved; otherwise it means the Promise has already been settled before.

Generated using TypeDoc