Class CompletablePromise<T>

A Promise that can be explicitly resolved or rejected.

Type Parameters

T = any

Hierarchy

CompletablePromise

Index

Constructors

constructor

new CompletablePromise<T>(): CompletablePromise<T>
Type Parameters
- T = any
Returns CompletablePromise<T>
- Defined in completable-promise.ts:19

Properties

`Protected` deferredPromise

deferredPromise: DeferredPromise<T>

`Private` `Readonly` promise

promise: Promise<T>

`Protected` state

state: State = State.Pending

Methods

catch

catch<TResult>(onrejected?): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)
  
  The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>
A Promise for the completion of the callback.
- Defined in completable-promise.ts:96

finally

finally(onfinally?): 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
- Optional onfinally: 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.
- Defined in completable-promise.ts:109

get

get(): Promise<T>
Returns the inner Promise instance.

Returns Promise<T>
The inner Promise instance.
- Defined in completable-promise.ts:118

getState

getState(): State
Returns the current Promise state.

Returns State
The current Promise state.
- Defined in completable-promise.ts:127

isFulfilled

isFulfilled(): boolean
Returns true if the Promise state it is Fulfilled.

Returns boolean
Whether the Promise state it is Fulfilled.
- Defined in completable-promise.ts:145

isPending

isPending(): boolean
Returns true if the Promise state it is Pending.

Returns boolean
Whether the Promise state it is Pending.
- Defined in completable-promise.ts:136

isRejected

isRejected(): boolean
Returns true if the Promise state it is Rejected.

Returns boolean
Whether the Promise state it is Rejected.
- Defined in completable-promise.ts:154

isSettled

isSettled(): boolean
Returns true if the Promise state it is either Fulfilled or Rejected.

Returns boolean
Whether the Promise state it is either Fulfilled or Rejected.
- Defined in completable-promise.ts:165

`Private` makeDeferredOperation

makeDeferredOperation(newState, deferredOperation): void
Calls the specified deferredOperation if the CompletablePromise state is Pending. Then sets the CompletablePromise state to the specified one.
Parameters
- newState: State
  
  The new state assigned to the CompletablePromise.
- deferredOperation: DeferredOperation<T>
  
  The method of the DeferredPromise that should be called.
Returns void
- Defined in completable-promise.ts:33

reject

reject(reason): void
Rejects the Promise with a provided reason or error. This method call will succeed only if the Promise state was Pending, and it will irreversibly change the Promise state to Rejected.
Parameters
- reason: any
  
  The reason or error.
Returns void
- Defined in completable-promise.ts:58

resolve

resolve(value): void
Resolves the Promise with a value or the result of another Promise. This method call will succeed only if the Promise state was Pending, and it will irreversibly change the Promise state to Fulfilled.
Parameters
- value: T | PromiseLike<T>
  
  The value or the result of another Promise.
Returns void
- Defined in completable-promise.ts:47

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
  
  The callback to execute when the Promise is resolved.
- Optional onrejected: null | ((reason) => 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.
- Defined in completable-promise.ts:83

tryResolve

tryResolve(getValue): void
Attempts to resolve the Promise with a value or the result of another Promise. If retrieving {@param getValue} result fails, reject function will be called instead.
Parameters
- getValue: (() => T | PromiseLike<T>)
  
  A function that returns the value or the result of another Promise.
  - - (): T | PromiseLike<T>
    - Returns T | PromiseLike<T>
Returns void
- Defined in completable-promise.ts:68

Class CompletablePromise<T>

Type Parameters

T = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T = any

Returns CompletablePromise<T>

Properties

Protected deferredPromise

Private Readonly promise

Protected state

Methods

catch

Type Parameters

TResult = never

Parameters

Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)

Returns Promise<T | TResult>

finally

Parameters

Optional onfinally: null | (() => void)

Returns Promise<T>

get

Returns Promise<T>

getState

Returns State

isFulfilled

Returns boolean

isPending

Returns boolean

isRejected

Returns boolean

isSettled

Returns boolean

Private makeDeferredOperation

Parameters

newState: State

deferredOperation: DeferredOperation<T>

Returns void

reject

Parameters

reason: any

Returns void

resolve

Parameters

value: T | PromiseLike<T>

Returns void

then

Type Parameters

TResult1 = T

TResult2 = never

Parameters

Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)

Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

Returns Promise<TResult1 | TResult2>

tryResolve

Parameters

getValue: (() => T | PromiseLike<T>)

Returns T | PromiseLike<T>

Returns void

Settings

Member Visibility

Theme

On This Page

`Protected` deferredPromise

`Private` `Readonly` promise

`Protected` state

`Optional` onrejected: null | ((reason) => TResult | PromiseLike<TResult>)

`Optional` onfinally: null | (() => void)

`Private` makeDeferredOperation

`Optional` onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)

`Optional` onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)