AbortSignal

Объект сигнала, который позволяет взаимодействовать с запросом DOM (например, Fetch) и прерывать его при необходимости с помощью объекта AbortController.

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; 
};

Расширяет

EventTarget

Свойства

readonly aborted: boolean

Возвращает true, если объект AbortController этого AbortSignal сигнализировал о прерывании, и false в противном случае.

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

Выбрасывает причину прерывания этого AbortSignal, если его AbortController сигнализировал о прерывании; в противном случае ничего не делает.