AbortSignal

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.

interface AbortSignal  extends EventTarget {
readonly aborted: boolean;
onabort: ((this: AbortSignal, ev: Event) => any) | null;

readonly reason: any;
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<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(): void;
}

var AbortSignal: {prototype: AbortSignal; 
new (): AbortSignal; 
abort(reason?: any): AbortSignal; 
timeout(milliseconds: number): AbortSignal; 
};

Extends

EventTarget

Properties

readonly aborted: boolean

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

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

readonly reason: any

Methods

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<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(): void

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