JavaScript свойство XMLHttpRequest.timeout
Определение и применение
JavaScript свойство timeout объекта
XMLHttpRequest
соответствует количеству миллисекунд, которые может занять запрос перед автоматическим завершением (предельное время
ожидания ответа в миллисекундах). Значение по умолчанию равно 0, что означает отсутствие тайм-аута.
Если время истекло, запрос прерывается: свойство readyState получает значение 4
(DONE), status — 0, и возникает событие timeout, а затем
loadend. Значение можно изменить и после вызова send(): время отсчитывается от начала
запроса.
В устаревшем Internet Explorer свойство timeout могло быть установлено только после вызова метода
open()
и перед вызовом метода
send().
Поддержка браузерами
Спецификация: xhr.spec.whatwg
Поддерживается во всех основных браузерах с 2015 года.
| Возможность | Компьютеры | Мобильные | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
timeout | 29 | 12 | 12 | 17 Версия 17 выпущена в 2013 г. Версия 12 выпущена в 2012 г. — Удалено в 16 | 7 | 29 | 14 | 18 Версия 18 выпущена в 2013 г. Версия 12 выпущена в 2012 г. — Удалено в 16 | 7 | 2.0 | 4.4 | 7 |
поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31
JavaScript синтаксис
// чтение
const timeout = xhr.timeout;
// запись
xhr.timeout = milliseconds;
Спецификация
Исключения
| Тип исключения | Описание |
|---|---|
InvalidAccessError |
Возникает в том случае, если тайм-аут был использован для синхронных запросов
XMLHttpRequest, используемых в среде документа.
|
Пример использования
const xhr = new XMLHttpRequest(); // создаем новый запрос
xhr.open("GET", "/info"); // определяем параметры для запроса
xhr.timeout = 5000; // устанавливаем предельное время ожидания в миллисекундах
xhr.onload = function() {
// запрос завершен
};
xhr.ontimeout = function() {
// время ожидания запроса истекло.
};
xhr.send(); // отправляем запрос на сервер