class AbortSignal

Signals abortion to abortable operations such as fetch().

Index

Properties

• aborted
• reason

Methods

• addEventListener(type, listener)
• removeEventListener(type, listener)
• AbortSignal.timeout(ms)

aborted boolean read-only

Whether the signal has been aborted.

addEventListener(type, listener)

Registers a listener.

addEventListener(type: string, listener: (...args: any[]) => void): void;

reason any read-only

The abort reason, when AbortSignal.aborted is true.

removeEventListener(type, listener)

Removes a previously registered listener.

removeEventListener(type: string, listener: (...args: any[]) => void): void;

AbortSignal.timeout(ms) static

Returns a signal that aborts automatically after ms milliseconds.

static timeout(ms: number): AbortSignal;