Skip to main content

@rtorcato/js-common / promises

promises

Functions​

delay()​

delay(ms): Promise<void>

Defined in: promises/index.ts:6

Returns a promise that resolves after a given delay (ms).

Parameters​

ms​

number

Milliseconds to wait.

Returns​

Promise<void>

to()​

to<T>(promise): Promise<[any, T | undefined]>

Defined in: promises/index.ts:16

Wraps a promise and returns a tuple [error, result].

Type Parameters​

T​

T

Parameters​

promise​

Promise<T>

The promise to wrap.

Returns​

Promise<[any, T | undefined]>

withTimeout()​

withTimeout<T>(promise, ms, error?): Promise<T>

Defined in: promises/index.ts:32

Returns a promise that rejects after a timeout if the input promise does not resolve.

Type Parameters​

T​

T

Parameters​

promise​

Promise<T>

The promise to race.

ms​

number

Timeout in milliseconds.

error?​

any = ...

Optional error to throw on timeout.

Returns​

Promise<T>

all()​

all<T>(promises): Promise<T[]>

Defined in: promises/index.ts:45

Returns a promise that resolves when all promises resolve, or rejects on the first rejection (like Promise.all).

Type Parameters​

T​

T

Parameters​

promises​

Promise<T>[]

Array of promises.

Returns​

Promise<T[]>

allSettled()​

allSettled<T>(promises): Promise<PromiseSettledResult<T>[]>

Defined in: promises/index.ts:54

Returns a promise that resolves when all promises settle (like Promise.allSettled).

Type Parameters​

T​

T

Parameters​

promises​

Promise<T>[]

Array of promises.

Returns​

Promise<PromiseSettledResult<T>[]>

race()​

race<T>(promises): Promise<T>

Defined in: promises/index.ts:63

Returns a promise that resolves or rejects as soon as one of the promises resolves or rejects (like Promise.race).

Type Parameters​

T​

T

Parameters​

promises​

Promise<T>[]

Array of promises.

Returns​

Promise<T>