opensensemap-client
    Preparing search index...

    Interface AbortSignal

    The AbortSignal interface represents a signal object that allows you to communicate with an asynchronous operation (such as a fetch request) and abort it if required via an AbortController object.

    MDN Reference

    interface AbortSignal {
        aborted: boolean;
        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 (View Summary)

    Index

    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

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

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

    MDN Reference

    Methods

    • 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

      Returns boolean

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

      MDN Reference

      Returns void