Class Abort

An Abort instance emits an 'abort' event when aborted.

A native AbortController is encapsulated if the platform supports it, allowing for fetch cancellation.

Hierarchy (View Summary)

EventHostImpl<AbortEventMap>
- Abort
  - TimeoutController

Implements

ReadonlyAbort

Index

Constructors

Properties

Accessors

[toStringTag] nativeSignal reason

Methods

abort aborted dispatch dispose hasAnyListeners hasListeners on onAborted throwIfAborted

Constructors

constructor

new Abort(deps?: AbortDeps): Abort
Parameters
- Optionaldeps: AbortDeps
Returns Abort
Overrides EventHostImpl.constructor
- Defined in util/async/Abort.ts:76

Properties

`Readonly`logPrefix

logPrefix: string = ...

A string prefix for all log statements made by this target.

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Overrides EventHostImpl.[toStringTag]
- Defined in util/async/Abort.ts:72

nativeSignal

get nativeSignal(): null | AbortSignal
Returns a native signal on supported platforms.

Returns null | AbortSignal
Implementation of ReadonlyAbort.nativeSignal
- Defined in util/async/Abort.ts:98

reason

get reason(): null | Error
A JavaScript value providing the abort reason, once this signal has aborted.

Returns null | Error
Implementation of ReadonlyAbort.reason
- Defined in util/async/Abort.ts:92

Methods

abort

abort(reason?: Error): void
Sets to the aborted state with the given reason, and emits an 'abort' event. If this signal is already aborted, this will do nothing.
Parameters
- reason: Error = ...
Returns void
- Defined in util/async/Abort.ts:141

aborted

aborted(): boolean
True if this signal is aborted.

Returns boolean
Implementation of ReadonlyAbort.aborted
- Defined in util/async/Abort.ts:85

dispatch

dispatch<K extends "abort">(type: K, event: AbortEventMap[K]): void
Dispatches an event.
Type Parameters
- K extends "abort"
Parameters
- type: K
  The key of the event within EventMap
- event: AbortEventMap[K]
  If the passed event is read-only, then it may be re-used/cached. Otherwise, it should be a new event object every dispatch. If no target property is set on the event, the target will be set to this host.
Returns void
Inherited from EventHostImpl.dispatch
- Defined in event/EventHost.ts:108

dispose

dispose(): void
Returns void
Inherited from EventHostImpl.dispose
- Defined in event/EventHost.ts:112

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Implementation of ReadonlyAbort.hasAnyListeners
Inherited from EventHostImpl.hasAnyListeners
- Defined in event/EventHost.ts:88

hasListeners

hasListeners(type: "abort"): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: "abort"
Returns boolean
Implementation of ReadonlyAbort.hasListeners
Inherited from EventHostImpl.hasListeners
- Defined in event/EventHost.ts:95

on

on<K extends "abort">(
    type: K,
    handler: EventHandler<AbortEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends "abort"
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<AbortEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Implementation of ReadonlyAbort.on
Inherited from EventHostImpl.on
- Defined in event/EventHost.ts:99

onAborted

onAborted(callback: (event: AbortEvent) => void): Unsubscribe
Invokes a callback on 'abort', or immediately if already aborted.
Parameters
- callback: (event: AbortEvent) => void
Returns Unsubscribe
Implementation of ReadonlyAbort.onAborted
- Defined in util/async/Abort.ts:128

throwIfAborted

throwIfAborted(): void
Throws this signal's abort reason if the signal has been aborted; otherwise it does nothing.

Returns void
Implementation of ReadonlyAbort.throwIfAborted
- Defined in util/async/Abort.ts:121