XMLHttpRequestEventTarget: timeout イベント
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since 2015年7月.
timeout イベントは、設定された時間が経過したことで進行が終了すると発行されます。
構文
このイベント名を addEventListener() のようなメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。
addEventListener("timeout", (event) => { })
ontimeout = (event) => { }
イベント型
ProgressEvent です。 Event から継承しています。
イベントのプロパティ
以下に挙げたプロパティに加えて、親インターフェイスである Event から継承したプロパティが利用できます。
lengthComputable読取専用-
論理値のフラグで、このプロセスで行われる作業の合計と、すでに行われた作業の量が計算可能かどうかを示します。言い換えれば、進捗が計測可能かどうかを示します。
loaded読取専用-
64 ビット符号なし整数値で、このプロセスで既に作業を行った量を示します。作業した比率は、
totalをこのプロパティの値で割ることで算出できます。 HTTP を使用してリソースをダウンロードする場合、これは HTTP メッセージの本文のみをカウントし、ヘッダーやその他のオーバーヘッドは含まれません。 total読取専用-
64 ビット符号なし整数で、基礎となるプロセスが実行中の作業の総量を表します。 HTTP を使用してリソースをダウンロードする場合、これは
Content-Length（メッセージの本文のサイズ）であり、ヘッダーやその他のオーバーヘッドは含まれません。
例
XMLHttpRequest での使い方
const client = new XMLHttpRequest();
client.open("GET", "http://www.example.org/example.txt");
client.ontimeout = () => {
console.error("Timeout!!");
};
client.send();
イベントハンドラーは addEventListener() メソッドを使用して設定することもできます。
client.addEventListener("timeout", () => {
console.error("Timeout!!");
});
XMLHttpRequestUpload での使い方
timeout イベントを使用すると、アップロードが遅すぎるために停止したことを検出することができます。ファイルをアップロードして進捗バーを表示する完全なコード例については、メインの XMLHttpRequestUpload ページを参照してください。
The timeout is set on the XMLHttpRequest object using the XMLHttpRequest.timeout property.
// タイムアウトが発生した場合、進捗バーを非表示にする
// なお、このイベントは xhr オブジェクトでも待ち受けすることができる
function errorAction(event) {
progressBar.classList.remove("visible");
log.textContent = `アップロードに失敗しました: ${event.type}`;
}
xhr.upload.addEventListener("timeout", errorAction);
仕様書
| Specification |
|---|
| XMLHttpRequest # event-xhr-timeout |
| XMLHttpRequest # handler-xhr-ontimeout |