Class AbortSignal

Copyright (c) 2025, Oracle and/or its affiliates.

Hierarchy (View Summary)

EventTarget
- AbortSignal

Index

Constructors

Properties

aborted onabort reason

Methods

addEventListener dispatchEvent removeEventListener throwIfAborted abort any

Constructors

constructor

new AbortSignal(): AbortSignal
Returns AbortSignal
Inherited from EventTarget.constructor

Properties

`Readonly`aborted

aborted: boolean

onabort

onabort: (this: AbortSignal, ev: Event) => any

`Readonly`reason

reason: any

Methods

addEventListener

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

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent

removeEventListener

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

throwIfAborted

throwIfAborted(): void
Returns void

`Static`abort

abort(reason?: any): AbortSignal
Parameters
- Optionalreason: any
Returns AbortSignal

`Static`any

any(signals: AbortSignal[]): AbortSignal
Parameters
- signals: AbortSignal[]
Returns AbortSignal