Function createAbortError

createAbortError(reason: unknown): Error

Creates an AbortError from the given error or value. Follows the convention: error.name === 'AbortError' with code: 20.

Parameters

reason: unknown
The error or value that caused the abort.

Returns Error

An Error with name: 'AbortError' and code: 20.

Example

// From an Error
const err = createAbortError(new Error('timeout'));
console.log(err.name); // 'AbortError'
console.log(err.code); // 20

Example

// From a string
const err = createAbortError('cancelled');

Example

// From an AbortSignal's reason
const controller = new AbortController();
controller.abort('timeout');
const err = createAbortError(controller.signal.reason);