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 full)

EventHostImpl<AbortEventMap>
- Abort

Implements

ReadonlyAbort

Index

Constructors

Properties

Accessors

[toStringTag] aborted reason signal

Methods

abort dispatch dispose hasAnyListeners hasListeners on onAborted throwIfAborted

Constructors

constructor

new Abort(): Abort
Returns Abort
Overrides EventHostImpl.constructor
- Defined in util/async/Abort.ts:79

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:68

aborted

get aborted(): boolean
True if the signal is aborted.

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

reason

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

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

signal

get signal(): null | AbortSignal
If native AbortController is supported, returns its abort signal.

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

Methods

abort

abort(reason?): 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:130

dispatch

dispatch<K>(type, event): 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): 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>(type, handler, options?): 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): Unsubscribe
Invokes a callback on 'abort', or immediately if already aborted.
Parameters
- callback: ((event: AbortEvent) => void)
  - - (event): void
    - Parameters
      event: AbortEvent
      Returns void
Returns Unsubscribe
Implementation of ReadonlyAbort.onAborted
- Defined in util/async/Abort.ts:117

throwIfAborted

throwIfAborted(): void
Throws the 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:110