EnhancedAbortSignal
constEnhancedAbortSignal:object
Defined in: src/EnhancedAbortSignal.ts:10
Helpers for any AbortSignal, including ones you didn’t create (fetch, frameworks, AbortSignal.timeout).
Every function returns or accepts real AbortSignals.
Type Declaration
Section titled “Type Declaration”none:
AbortSignal
A signal that never aborts, always the same object. Use as a default for optional signals.
aborted
Section titled “aborted”Get Signature
Section titled “Get Signature”get aborted():
AbortSignal
A new, already-aborted signal (reason: an AbortError DOMException).
Returns
Section titled “Returns”AbortSignal
any(
signals):AbortSignal
AbortSignal.any, skipping undefined/null (optional signals) and none. The native implementation
releases its links when the result is garbage-collected, so per-request use on a long-lived signal doesn’t leak.
Parameters
Section titled “Parameters”signals
Section titled “signals”Iterable<AbortSignal | null | undefined>
Returns
Section titled “Returns”AbortSignal
canBeAborted()
Section titled “canBeAborted()”canBeAborted(
signal):boolean
False only for EnhancedAbortSignal.none: whether the signal can ever abort. .NET’s CanBeCanceled.
Parameters
Section titled “Parameters”signal
Section titled “signal”AbortSignal
Returns
Section titled “Returns”boolean
register()
Section titled “register()”register(
signal,callback):AbortRegistration
See register().
Parameters
Section titled “Parameters”signal
Section titled “signal”AbortSignal
callback
Section titled “callback”(reason) => void
Returns
Section titled “Returns”timeout()
Section titled “timeout()”timeout(
delay):AbortSignal
AbortSignal.timeout that also accepts a TimeSpan, Infinity (returns none) and delays over 24.8 days.
Aborts with a TimeoutError; never keeps the process alive.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”AbortSignal
whenAborted()
Section titled “whenAborted()”whenAborted(
signal):Promise<unknown>
See whenAborted().
Parameters
Section titled “Parameters”signal
Section titled “signal”AbortSignal
Returns
Section titled “Returns”Promise<unknown>