Skip to main content

Function: createCombinedAbortSignal()

createCombinedAbortSignal(options: CombineSignalsOptions): AbortSignal

Defined in: shared/utils/abortUtils.ts:91

Creates an AbortSignal that aborts when any configured source aborts.

Parameters​

options​

CombineSignalsOptions = {}

Composite signal configuration options.

Returns​

AbortSignal

An AbortSignal that mirrors the earliest abort condition.

Remarks​

The composite signal can observe additional caller-provided signals and an optional timeout window. When neither a timeout nor additional signals are provided, the function returns a signal that never aborts. Providing a timeout reason ensures the composed signal exposes a meaningful reason value when the timeout elapses.

Example​

const controller = new AbortController();
const combinedSignal = createCombinedAbortSignal({
    timeoutMs: 5000,
    additionalSignals: [controller.signal],
    reason: "Operation timeout or user cancellation",
});

await fetch(url, { signal: combinedSignal });