Class LazyPromise<T>

A Promise whose executor will not execute until the first time it is awaited.

Type Parameters

T

Hierarchy (view full)

ExtensiblePromise<T>
- LazyPromise

Index

Constructors

Accessors

Methods

catch finally then from

Constructors

constructor

new LazyPromise<T>(executor): LazyPromise<T>
Type Parameters
- T
Parameters
- executor: LazyPromise.Executor<T>
Returns LazyPromise<T>
Overrides ExtensiblePromise.constructor
- Defined in src/classes/LazyPromise.ts:31

Accessors

[toStringTag]

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

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.
Overrides ExtensiblePromise.catch
- Defined in src/classes/LazyPromise.ts:54

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.
Overrides ExtensiblePromise.finally
- Defined in src/classes/LazyPromise.ts:63

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.
Overrides ExtensiblePromise.then
- Defined in src/classes/LazyPromise.ts:44

`Static`from

from<T>(create): LazyPromise<T>
Creates a LazyPromise from a function.
Type Parameters
- T
Parameters
- create: Callable<void, T | PromiseLike<T>>
Returns LazyPromise<T>
- Defined in src/classes/LazyPromise.ts:21