Deferred

Deferred: object

Defined in: Core/Deferred.ts:24

Type Declaration

all

all: <T>(deferreds) => Deferred<{ [K in string | number | symbol]: T[K] extends Deferred<A> ? A : never }>

Combines an array or tuple of Deferred values into a single Deferred of a tuple. Resolves when all input Deferreds resolve.

Type Parameters

T

T extends readonly Deferred<unknown>[]

Parameters

deferreds

T

Returns

Deferred<{ [K in string | number | symbol]: T[K] extends Deferred<A> ? A : never }>

Example

const [a, b] = await Deferred.all([d1, d2]);

from

from: object

from.Promise

Promise: <A>(p) => Deferred<A> = fromPromise

Wraps a Promise or Deferred into a Deferred, structurally excluding rejection handlers, .catch(), .finally(), and chainable .then().

Precondition: p must never reject. If p rejects, the returned Deferred will never resolve — await-ing it will hang indefinitely. Use Task.Result.tryCatch to handle operations that may fail before converting to a Deferred.

Type Parameters

A

A

Parameters

p

Thenable<A>

Returns

Deferred<A>

Example

const d = Deferred.from.Promise(Promise.resolve("hello"));
const value = await d; // "hello"

race

race: <A>(deferreds) => Deferred<A>

Races multiple Deferred values and resolves with the first one to settle.

Type Parameters

A

A

Parameters

deferreds

readonly Deferred<A>[]

Returns

Deferred<A>

Example

const winner = await Deferred.race([d1, d2]);

to

to: object

to.Promise

Promise: <A>(d) => Promise<A> = toPromise

Converts a Deferred back into a Promise.

Type Parameters

A

A

Parameters

d

Deferred<A>

Returns

Promise<A>

Example

const p = Deferred.to.Promise(Deferred.from.Promise(Promise.resolve(42)));
// p is Promise<42>