AbortSignal: abort() static method

Available in workers

The AbortSignal.abort() static method returns an AbortSignal that is already set as aborted (and which does not trigger an abort event).

This is shorthand for the following code:

const controller = new AbortController();
controller.abort();
return controller.signal;

This could, for example, be passed to a fetch method in order to run its abort logic (i.e., it may be that code is organized such that the abort logic should be run even if the intended fetch operation has not been started).

[!NOTE] The method is similar in purpose to reject.

Syntax

AbortSignal.abort()
AbortSignal.abort(reason)

Parameters

• reason
  • : The reason why the operation was aborted, which can be any JavaScript value. If not specified, the reason is set to “AbortError” DOMException.

Return value

An AbortSignal instance with the aborted property set to true, and reason set to the specified or default reason value.

Specifications

Browser compatibility