Interface RetimeableAbortSignal

An extension to the AbortSignal interface that allows resetting the timer after which the signal will fire it's "abort" event.

interface RetimeableAbortSignal {
    aborted: boolean;
    onabort: null | ((this, ev) => any);
    reason: any;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    clear(): void;
    dispatchEvent(event): boolean;
    dispatchEvent(event): boolean;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    reset(ms?): void;
    throwIfAborted(): void;
    throwIfAborted(): void;
    throwIfAborted(): void;
}

Hierarchy

Properties

aborted onabort reason

Methods

addEventListener clear dispatchEvent removeEventListener reset throwIfAborted

Properties

Readonly aborted

aborted: boolean

Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise.

MDN Reference

onabort

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

MDN Reference

Type declaration

Readonly reason

reason: any

MDN Reference

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "abort"

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "abort"

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

clear

  • clear(): void

  • Clear the timer, the "abort" event will no longer be fired

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "abort"

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "abort"

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

reset

  • reset(ms?): void

  • Reset the timer. If ms is specified, the timer will fire this many ms in the future, otherwise it will fire according to the ms arg originally passed to retimerSignal.

    Parameters

    • Optional ms: number

    Returns void

throwIfAborted

  • throwIfAborted(): void

  • MDN Reference

    Returns void

  • throwIfAborted(): void

  • MDN Reference

    Returns void

  • throwIfAborted(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

abortedonabortreasonaddEventListenercleardispatchEventremoveEventListenerresetthrowIfAborted