Class DeferredPromise<T>

An externally actionable Promise with resolve and reject methods.

Type Parameters

T

Hierarchy (view full)

ExtensiblePromise<T>
- DeferredPromise

Index

Constructors

Accessors

Methods

catch finally reject resolve then

Constructors

constructor

new DeferredPromise<T>(): DeferredPromise<T>
Type Parameters
- T
Returns DeferredPromise<T>
Overrides ExtensiblePromise.constructor
- Defined in src/classes/DeferredPromise.ts:13

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Overrides ExtensiblePromise.[toStringTag]
- Defined in src/classes/DeferredPromise.ts:23

Methods

catch

catch<TF>(onrejected?): Promise<T | TF>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TF = never
Parameters
- Optionalonrejected: null | Callable<unknown, TF | PromiseLike<TF>>
  The callback to execute when the Promise is rejected.
Returns Promise<T | TF>
A Promise for the completion of the callback.
Inherited from ExtensiblePromise.catch
- Defined in src/classes/ExtensiblePromise.ts:32

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
- Optionalonfinally: null | Callable
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>
A Promise for the completion of the callback.
Inherited from ExtensiblePromise.finally
- Defined in src/classes/ExtensiblePromise.ts:40

reject

reject(reason): void
Rejects the promise with reason.
Parameters
- reason: unknown
Returns void
- Defined in src/classes/DeferredPromise.ts:35

resolve

resolve(value): void
Resolves the promise with value.
Parameters
- value: T | PromiseLike<T>
Returns void
- Defined in src/classes/DeferredPromise.ts:29

then

then<TS, TF>(onfulfilled?, onrejected?): Promise<TS | TF>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TS = T
- TF = never
Parameters
- Optionalonfulfilled: null | Callable<T, TS | PromiseLike<TS>>
  The callback to execute when the Promise is resolved.
- Optionalonrejected: null | Callable<unknown, TF | PromiseLike<TF>>
  The callback to execute when the Promise is rejected.
Returns Promise<TS | TF>
A Promise for the completion of which ever callback is executed.
Inherited from ExtensiblePromise.then
- Defined in src/classes/ExtensiblePromise.ts:23