Interface PromiseTimeoutOptions<T>

Type Parameters

  • T

Hierarchy

  • PromiseTimeoutOptions

Properties

abortController? abortErrorMessage? timeoutErrorMessage? timeoutMs

Methods

cleanupOnLateReject? cleanupOnLateResolve?

Properties

Optional abortController

abortController?: AbortController

The abort controller to both listen for changes to abort early, and to invoke abort when timeout is reached.

Optional abortErrorMessage

abortErrorMessage?: string

The custom error message to use when the promise is aborted.

Optional timeoutErrorMessage

timeoutErrorMessage?: string

The custom error message to use when the timeout is reached.

timeoutMs

timeoutMs: number

The elapsed time in milliseconds before the promise will reject. Values of infinity will return the original promise.

Methods

Optional cleanupOnLateReject

  • The function to invoke if the promise eventually rejects with a value.

    Parameters

    • error: Error

    Returns void

Optional cleanupOnLateResolve

  • The function to invoke if the promise eventually resolves with a value.

    Parameters

    • value: T

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc