Interface 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 {
    aborted: boolean;
    onabort: Object;
    reason: any;
    addEventListener(type: string, listener: EventListener | EventListenerObject, options?: boolean | AddEventListenerOptions): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener(type: string, listener: EventListener | EventListenerObject, options?: boolean | EventListenerOptions): void;
    throwIfAborted(): void;
}

Hierarchy (view full)

Properties

aborted onabort reason

Methods

addEventListener dispatchEvent removeEventListener throwIfAborted

Properties

Readonlyaborted

aborted: boolean

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

onabort

onabort: Object

Readonlyreason

reason: any

Methods

addEventListener

  • addEventListener(type, listener, options?): void

  • Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

    If the once option is true, the listener is removed after the next time a type event is dispatched.

    The capture option is not used by Node.js in any functional way other than tracking registered event listeners per the EventTarget specification. Specifically, the capture option is used as part of the key when registering a listener. Any individual listener may be added once with capture = false, and once with capture = true.

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

removeEventListener

throwIfAborted

  • throwIfAborted(): void

  • Returns void

Settings

Member Visibility

On This Page

Properties
Methods