Interface ReadonlyAbort

interface ReadonlyAbort {
    nativeSignal: null | AbortSignal;
    reason: null | Error;
    aborted(): boolean;
    hasAnyListeners(): boolean;
    hasListeners(type: "abort"): boolean;
    on<K extends "abort">(
        type: K,
        handler: EventHandler<AbortEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
    onAborted(callback: (event: AbortEvent) => void): Unsubscribe;
    throwIfAborted(): void;
}

Hierarchy (View Summary)

ReadonlyEventHost<AbortEventMap>
- ReadonlyAbort

Implemented by

Index

Properties

nativeSignal reason

Methods

aborted hasAnyListeners hasListeners on onAborted throwIfAborted

Properties

`Readonly`nativeSignal

nativeSignal: null | AbortSignal

Returns a native signal on supported platforms.

`Readonly`reason

reason: null | Error

The reason passed to abort.

Methods

aborted

aborted(): boolean
True if aborted.

Returns boolean
- Defined in util/async/Abort.ts:23

hasAnyListeners

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

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in event/EventHost.ts:44

hasListeners

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

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.
Inherited from ReadonlyEventHost.on
- Defined in event/EventHost.ts:35

onAborted

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

throwIfAborted

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

Returns void
- Defined in util/async/Abort.ts:33