AbortSignal

interface

interface AbortSignal extends EventTarget

A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.

variable

var AbortSignal: { … }

The constructor object for AbortSignal.

AbortSignal instances are obtained from an AbortController or via the static abort, timeout, and any factory methods rather than constructed directly, so calling the constructor throws.

Constructors

`constructor`

new AbortSignal(): never

Properties

`aborted`

readonly aborted: boolean

Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise.

`reason`

readonly reason: any

`onabort`

onabort: ((this: AbortSignal, ev: Event) => any) | null

`prototype`

readonly prototype: AbortSignal

Methods

`addEventListener`

addEventListener<K extends keyof AbortSignalEventMap>(type: K, listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void

addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

`removeEventListener`

removeEventListener<K extends keyof AbortSignalEventMap>(type: K, listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any, options?: boolean | EventListenerOptions): void

removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

`throwIfAborted`

throwIfAborted(): void

Throws this AbortSignal's abort reason, if its AbortController has signaled to abort; otherwise, does nothing.

`abort`

abort(reason?: any): AbortSignal

`any`

any(signals: AbortSignal[]): AbortSignal

`timeout`

timeout(milliseconds: number): AbortSignal