AbortSignal: timeout() 静的メソッド

メモ: この機能はウェブワーカー内で利用可能です。

AbortSignal.timeout() は静的メソッドで、指定した時間が経過すると自動的に中止する AbortSignal を返すものです。

このシグナルは、タイムアウト時には TimeoutError DOMException で、ブラウザーの停止ボタン（または他の組み込まれた「停止」処理）を押した場合には AbortError DOMException で中止されます。 これにより、通常ユーザーへの通知が必要なタイムアウトエラーと、そうでないユーザーによる中止の発生を UI で区別できます。

タイムアウトは経過時間ではなく活動時間に基づきます。コードが実行されているワーカーがサスペンドされている場合や、文書がバックフォワードキャッシュ ("bfcache") にある場合は、事実上一時停止されます。

複数のシグナルを組み合わせるには、AbortSignal.any() を使用することができます。例えば、タイムアウトシグナルまたは AbortController.abort() を呼び出してダウンロードを直接中止させることができます。

構文

js
AbortSignal.timeout(time)

引数

time

返された AbortSignal が中止するまでの「アクティブ」な時間をミリ秒単位で指定します。

返値

AbortSignal です。

このシグナルはタイムアウト時に AbortSignal.reason プロパティに TimeoutError DOMException が、ユーザーによって処理が発生した場合には AbortError DOMException が設定されて中断されます。

例

フェッチ処理に失敗した場合、5 秒後にタイムアウトする単純な例を下記に示します。 このメソッドが対応していない場合、ブラウザーの「停止」ボタンが押された場合、他にも何らかの理由で失敗する可能性があることに注意してください。

js
const url = "https://path_to_large_file.mp4";

try {
  const res = await fetch(url, { signal: AbortSignal.timeout(5000) });
  const result = await res.blob();
  // …
} catch (err) {
  if (err.name === "TimeoutError") {
    console.error("Timeout: It took more than 5 seconds to get the result!");
  } else if (err.name === "AbortError") {
    console.error(
      "Fetch aborted by user action (browser stop button, closing tab, etc.",
    );
  } else if (err.name === "TypeError") {
    console.error("AbortSignal.timeout() method is not supported");
  } else {
    // A network error, or some other problem.
    console.error(`Error: type: ${err.name}, message: ${err.message}`);
  }
}

仕様書

Specification
DOM Standard
# ref-for-dom-abortsignal-timeout①

ブラウザーの互換性

BCD tables only load in the browser