Type Alias: IPromisE_Timeout<T>

IPromisE_Timeout<T> = IPromisE<T> & object

Defined in: packages/promise/src/types/timeout.ts:9

Descibes a timeout PromisE and it's additional properties.

Type Declaration

abortCtrl?

readonly optional abortCtrl: AbortController

aborted

readonly aborted: boolean

Read-only property indicating if the promise rejected because of external abort.

cancelAbort()

cancelAbort: () => void

Removes abortCtrl/signal listeners, effectively disabling external cancellation via AbortController.

Returns

void

clearTimeout()

clearTimeout: () => void

Clears the timeout timer, preventing the promise from being rejected due to a timeout.

Returns

void

data

data: IPromisE<T>

The underlying data promise. If multiple promises were passed to timeout, this represents the combined result (defaulting to PromisE.all).

timedout

readonly timedout: boolean

Read-only property indicating if the promise timed out. Equivalent to checking promise.timeout.rejected.

timeout

timeout: IPromisE_Delay<T>

The internal promise that handles the timeout logic. It rejects when the duration expires.

Type Parameters

T

T = unknown