XMLHttpRequestUpload: timeout イベント

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

timeout イベントはあらかじめ設定された時間が過ぎて進行が終了したときに発行されます。

構文

このイベント名を addEventListener() 等のメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。

addEventListener("timeout", (event) => {});

ontimeout = (event) => {};

イベント型

ProgressEvent です。 Event から継承しています。

イベントプロパティ

親である Event からプロパティを継承しています。

lengthComputable 読取専用: 論理値で、このプロセスで行われる作業の合計と、すでに行われた作業の量が計算可能かどうかを示す。言い換えれば、進捗が計測可能かどうかを示します。
loaded 読取専用: 64 ビット符号なし整数値で、このプロセスで既に作業を行った量を示します。作業した比率は、total をこのプロパティの値で割ることで算出できます。 HTTP を使用してリソースをダウンロードする場合、これは HTTP メッセージの本文のみをカウントし、ヘッダーやその他のオーバーヘッドは含まれません。
total 読取専用: 64 ビット符号なし整数で、基礎となるプロセスが実行中の作業の総量を表します。 HTTP を使用してリソースをダウンロードする場合、これは Content-Length （メッセージの本文のサイズ）であり、ヘッダーやその他のオーバーヘッドは含まれません。

例

`timeout` イベントの使用

timeout イベントを使用することで、アップロードに時間がかかりすぎて停止したことを検出することができます。ファイルをアップロードして進捗バーを表示する完全なコード例については、メインの XMLHttpRequestUpload ページを参照してください。

タイムアウトは XMLHttpRequest オブジェクトで XMLHttpRequest.timeout プロパティを使用して設定します。

// タイムアウトの場合、プログレスバーを非表示にする
// これらのイベントは xhr オブジェクトでも待ち受けすることができることに注意
function errorAction(event) {
  progressBar.classList.remove("visible");
  log.textContent = `Upload failed: ${event.type}`;
}
xhr.upload.addEventListener("timeout", errorAction);

仕様書

Specification
XMLHttpRequest Standard # event-xhr-timeout
XMLHttpRequest Standard # handler-xhr-ontimeout

ブラウザーの互換性

BCD tables only load in the browser