Class SyncPromise<T>

A promise that will make its resolved or rejected values synchronously available and operable.

Type Parameters

T

Hierarchy (view full)

ExtensiblePromise<T>
- SyncPromise

Index

Constructors

Accessors

Methods

catch consume finally operate then from

Constructors

constructor

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

Accessors

[toStringTag]

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

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

consume

consume(): T | Promise<T>
Returns a Promise if pending, otherwise it will synchronously return or throw.

Returns T | Promise<T>
- Defined in src/classes/SyncPromise.ts:83

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

operate

operate<TS, TF>(success?, failure?, finalize?): SyncPromise<TS | TF>
An agnostic and chainable method to operate on a SyncPromise. It will execute asynchronously if values are pending, and synchronously otherwise.
Type Parameters
- TS = T
- TF = never
Parameters
- Optionalsuccess: null | Callable<T, TS | PromiseLike<TS>>
- Optionalfailure: null | Callable<unknown, TF | PromiseLike<TF>>
- Optionalfinalize: null | Callable<void, void | PromiseLike<void>>
Returns SyncPromise<TS | TF>
- Defined in src/classes/SyncPromise.ts:98

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

`Static`from

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