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.

Hierarchy

  • EventTarget
    • AbortSignal

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.

onabort

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

Readonly reason

reason: any

Methods

addEventListener

dispatchEvent

  • 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

    • event: Event

    Returns boolean

removeEventListener

throwIfAborted

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc