Skip to main content
interface AbortSignal
extendsEventTarget ,
private

A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.

Properties

readonly
aborted: boolean

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

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

Methods

addEventListener<K extends keyof AbortSignalEventMap>(
type: K,
listener: (
) => any,
options?: boolean | AddEventListenerOptions,
): void
addEventListener(
type: string,
options?: boolean | AddEventListenerOptions,
): void
removeEventListener<K extends keyof AbortSignalEventMap>(
type: K,
listener: (
) => any,
options?: boolean | EventListenerOptions,
): void
removeEventListener(
type: string,
options?: boolean | EventListenerOptions,
): void

Throws this AbortSignal's abort reason, if its AbortController has signaled to abort; otherwise, does nothing.

Back to top