JavaScript AbortSignal.timeout: отменить fetch по таймеру

Категория: JavaScript · Язык: JavaScript · Обновлено:

AbortSignal.timeout(ms) возвращает сигнал, который автоматически отменяется через заданное время. Его передают в fetch или другую API, поддерживающую AbortSignal, чтобы запрос не висел бесконечно. В отличие от AbortController, не нужно вручную вызывать abort() и очищать таймер.

Проверить срабатывание сигнала

JavaScript
const signal = AbortSignal.timeout(20);

console.log(signal.aborted); // false
await new Promise((resolve) => setTimeout(resolve, 40));
console.log(signal.aborted); // true
console.log(signal.reason.name); // TimeoutError

Сигнал отменяется один раз; reason содержит DOMException с именем TimeoutError. Для fetch это означает, что промис отклонится, а тело ответа не будет прочитано. Проверяйте error.name, а не текст сообщения: он локализуется.

Использовать в fetch

JavaScript
try {
    const response = await fetch("https://example.com", {
        signal: AbortSignal.timeout(5000),
    });
    console.log(response.status);
} catch (error) {
    if (error.name === "TimeoutError") {
        console.log("запрос превысил лимит");
    } else {
        throw error;
    }
}

Таймер начинается при создании сигнала, а не при вызове fetch. Создавайте его непосредственно перед запросом. Для ручной отмены вместе с таймаутом объедините сигналы: AbortSignal.any([controller.signal, AbortSignal.timeout(5000)]) (Chrome 116+, Node 20.3+).

AbortSignal.timeout не отменяет серверную операцию и не гарантирует, что запрос не дошёл. Для идемпотентных GET это нормально; для POST/PUT используйте idempotency key и повтор с осторожностью. Не ставьте слишком маленький таймаут для мобильных сетей.

Метод поддерживается в Chrome 103+, Firefox 100+, Safari 16+ и Node.js 17.3+. В старых окружениях используйте AbortController с setTimeout и clearTimeout в finally. Не создавайте сигнал на весь жизненный цикл приложения: он отменится один раз и больше не подойдёт.

Документация: AbortSignal.timeout, AbortSignal.any.