redlock-universal
    Preparing search index...

    Interface ExtendedAbortSignal

    Enhanced AbortSignal with error information

    interface ExtendedAbortSignal {
        aborted: boolean;
        error?: Error;
        onabort: ((this: AbortSignal, ev: Event) => any) | null;
        reason: any;
        addEventListener<K extends "abort">(
            type: K,
            listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        removeEventListener<K extends "abort">(
            type: K,
            listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        throwIfAborted(): void;
    }

    Hierarchy

    • AbortSignal
      • ExtendedAbortSignal
    Index

    Properties

    aborted error? onabort reason

    Methods

    addEventListener dispatchEvent removeEventListener throwIfAborted

    Properties

    aborted: boolean

    The aborted read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (true) or not (false).

    MDN Reference

    error?: Error

    Error that caused the abort (if any)

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

    MDN Reference

    reason: any

    The reason read-only property returns a JavaScript value that indicates the abort reason.

    MDN Reference

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Type Parameters

      • K extends "abort"

      Parameters

      • type: K
      • listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Type Parameters

      • K extends "abort"

      Parameters

      • type: K
      • listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • The throwIfAborted() method throws the signal's abort AbortSignal.reason if the signal has been aborted; otherwise it does nothing.

      MDN Reference

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods