AbortSignal | Plan Engine

Hierarchy

EventTarget
- AbortSignal

Index

Properties

Methods

Properties

EventTarget

EventTarget: object

Type declaration

constructor: function
- new __type(): EventTarget
- - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5082
  Returns EventTarget
prototype: EventTarget

aborted

aborted: boolean

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

onabort

onabort: function | null

Methods

addEventListener

addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Overrides EventTarget.addEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:1667
Type parameters
- K: keyof AbortSignalEventMap
Parameters
- type: K
- listener: function
  - - (this: AbortSignal, ev: AbortSignalEventMap[K]): any
    - Parameters
      - this: AbortSignal
      - ev: AbortSignalEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:1668
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5074
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

removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Overrides EventTarget.removeEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:1669
Type parameters
- K: keyof AbortSignalEventMap
Parameters
- type: K
- listener: function
  - - (this: AbortSignal, ev: AbortSignalEventMap[K]): any
    - Parameters
      - this: AbortSignal
      - ev: AbortSignalEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:1670
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Hierarchy

Index

Properties

Methods

Properties

EventTarget

Type declaration

constructor: function

Returns EventTarget

prototype: EventTarget

aborted

onabort

Methods

addEventListener

Type parameters

K: keyof AbortSignalEventMap

Parameters

type: K

listener: function

Parameters

this: AbortSignal

ev: AbortSignalEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

removeEventListener

Type parameters

K: keyof AbortSignalEventMap

Parameters

type: K

listener: function

Parameters

this: AbortSignal

ev: AbortSignalEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void