XMLHttpRequest: 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() のようなメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。

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

ontimeout = (event) => {};

イベント型

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

Event ProgressEvent

イベントのプロパティ

以下に挙げたプロパティに加えて、親インターフェイスである Event から継承したプロパティが利用できます。

lengthComputable 読取専用

論理値で、このプロセスで行われる作業の合計と、すでに行われた作業の量が計算可能かどうかを示す。言い換えれば、進捗が計測可能かどうかを示します。

loaded 読取専用

64 ビット符号なし整数値で、このプロセスで既に作業を行った量を示します。作業した比率は、total をこのプロパティの値で割ることで算出できます。 HTTP を使用してリソースをダウンロードする場合、これは HTTP メッセージの本文のみをカウントし、ヘッダーやその他のオーバーヘッドは含まれません。

total 読取専用

64 ビット符号なし整数で、基礎となるプロセスが実行中の作業の総量を表します。 HTTP を使用してリソースをダウンロードする場合、これは Content-Length （メッセージの本文のサイズ）であり、ヘッダーやその他のオーバーヘッドは含まれません。

例

js
const client = new XMLHttpRequest();
client.open("GET", "http://www.example.org/example.txt");
client.ontimeout = () => {
  console.error("Timeout!!");
};

client.send();

イベントハンドラーは addEventListener() メソッドを使用して設定することもできます。

js
client.addEventListener("timeout", () => {
  console.error("Timeout!!");
});

仕様書

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

ブラウザーの互換性

BCD tables only load in the browser

関連情報