Class TimeoutWrapper

Races a promise against a timeout, rejecting with TimeoutError if exceeded.

Implements

ITimeoutWrapper

Index

Constructors

Methods

Constructors

constructor

new TimeoutWrapper(): TimeoutWrapper

Returns TimeoutWrapper

Methods

wrap

wrap<T>(
    promise: Promise<T>,
    timeoutMs: number,
    operationName: string,
): Promise<T>
Wraps a promise with a deadline, rejecting if the deadline is exceeded.
Type Parameters
- T
Parameters
- promise: Promise<T>
  The async operation to time-box.
- timeoutMs: number
  Maximum allowed duration in milliseconds.
- operationName: string
  Label used in the TimeoutError message.
Returns Promise<T>
The resolved value of the original promise if it completes in time.
Implementation of ITimeoutWrapper.wrap
- Defined in Resilience/TimeoutWrapper.ts:23