Skip to content
Makaio Framework

Function: createTimeoutSignal()

Makaio Framework

Makaio Framework / utils / createTimeoutSignal

Function: createTimeoutSignal()

Section titled “Function: createTimeoutSignal()”

createTimeoutSignal(timeoutMs): TimeoutSignal

Defined in: ../../../packages/utils/src/timeout/signal.ts:29

Create an AbortSignal that aborts after timeoutMs milliseconds.

Always call TimeoutSignal.clear in a finally block to prevent the timer from leaking when the guarded operation completes before the timeout elapses.

Parameters

Section titled “Parameters”

timeoutMs

Section titled “timeoutMs”

number

Timeout duration in milliseconds.

Returns

Section titled “Returns”

TimeoutSignal

A TimeoutSignal containing the signal and a clear callback.

Example

Section titled “Example”
const timeout = createTimeoutSignal(5_000);
try {
  const response = await fetch(url, { signal: timeout.signal });
} finally {
  timeout.clear();
}