TimeoutError

タイムアウトした操作を表すエラークラスです。

const error = new TimeoutError(message);

参照

new TimeoutError(message?)

操作の制限時間が過ぎた時に使用するエラークラスです。timeoutやwithTimeoutなどの操作の制限時間が過ぎた時にスローされます。

import { TimeoutError } from 'es-toolkit/error';

// デフォルトメッセージでエラーを作成します。
throw new TimeoutError();
// エラーメッセージ: 'The operation was timed out'

// カスタムメッセージでエラーを作成します。
throw new TimeoutError('APIリクエストがタイムアウトしました');
// エラーメッセージ: 'APIリクエストがタイムアウトしました'

タイムアウトと一緒に使用する例です。

import { timeout, TimeoutError } from 'es-toolkit';

async function fetchWithTimeout(url: string) {
  try {
    const response = await timeout(() => fetch(url), 3000);
    return response;
  } catch (error) {
    if (error instanceof TimeoutError) {
      console.log('リクエストがタイムアウトしました');
    }
    throw error;
  }
}

// 3秒以上かかると TimeoutError をスロー
await fetchWithTimeout('https://example.com/api/slow');

パラメータ

• message (string, オプション): エラーメッセージです。デフォルト値は'The operation was timed out'です。

戻り値

(TimeoutError): タイムアウトした操作を表すエラーインスタンスを返します。Errorを継承しており、nameプロパティは'TimeoutError'です。