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

Index

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: ((this, ev) => any)

Type declaration

- (this, ev): any
- MDN Reference
  Parameters
  - this: AbortSignal
  - ev: Event
  Returns any

`Readonly` reason

reason: any

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends "abort"
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: AbortSignal
      
      ev: AbortSignalEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void

Overrides EventTarget.addEventListener
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

Overrides EventTarget.addEventListener

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
- event: Event
Returns boolean

Inherited from EventTarget.dispatchEvent

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends "abort"
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: AbortSignal
      
      ev: AbortSignalEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

Overrides EventTarget.removeEventListener
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Overrides EventTarget.removeEventListener

throwIfAborted

throwIfAborted(): void
MDN Reference

Returns void