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.

MDN Reference

interface AbortSignal {
    aborted: boolean;
    onabort: null | ((this, ev) => any);
    reason: any;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    dispatchEvent(event): boolean;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    throwIfAborted(): void;
}

Hierarchy (view full)

Properties

aborted onabort reason

Methods

addEventListener dispatchEvent removeEventListener throwIfAborted

Properties

Readonly aborted

aborted: boolean

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

MDN Reference

onabort

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

MDN Reference

Type declaration

Readonly reason

reason: any

MDN Reference

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Type Parameters

    • K extends "abort"

    Parameters

    Returns void

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

  • 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.

    MDN Reference

    Parameters

    Returns boolean

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Type Parameters

    • K extends "abort"

    Parameters

    Returns void

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

  • Parameters

    Returns void

throwIfAborted

  • throwIfAborted(): void

  • MDN Reference

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc