maplibre-gl/src/util/abort_error.ts

BSD licensed community fork of mapbox-gl, a WebGL interactive maps library

/**
 * An error message to use when an operation is aborted
 */
export const ABORT_ERROR = 'AbortError';

export class AbortError extends Error {
    name = ABORT_ERROR;

    constructor(messageOrError: string | Error = ABORT_ERROR) {
        super(messageOrError instanceof Error ? messageOrError.message : messageOrError);
        if (messageOrError instanceof Error && messageOrError.stack) {
            this.stack = messageOrError.stack;
        }
    }
}

/**
 * Check if an error is an abort error
 * @param error - An error object
 * @returns - true if the error is an abort error
 */
export function isAbortError(error: unknown): boolean {
    return error instanceof Error && error.name === ABORT_ERROR;
}

/**
 * Throws an AbortError if the provided abort signal has already been aborted.
 *
 * @param signal - The abort signal to check.
 * @throws AbortError If the signal is aborted.
 */
export function throwIfAborted(signal: AbortSignal): void {
    if (signal.aborted) {
        throw new AbortError(signal.reason);
    }
}