@tai-kun/surrealdb/src/utils/get-timeout-signal.ts

The SurrealDB SDK for JavaScript

import { UnsupportedRuntimeError } from "@tai-kun/surrealdb/errors";
import isBrowser from "./is-browser";

// See https://caniuse.com/mdn-api_abortsignal_timeout_static
// See https://github.com/nodejs/node/blob/v22.2.0/lib/internal/abort_controller.js#L209-L221
/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/utils/get-timeout-signal/)
 */
export default function getTimeoutSignal(milliseconds: number): AbortSignal {
  if (typeof AbortSignal.timeout === "function") {
    return AbortSignal.timeout(milliseconds);
  }

  if (isBrowser()) {
    const controller = new AbortController();
    const timeoutId = setTimeout(
      () => {
        const reason = new DOMException("signal timed out", "TimeoutError");
        controller.abort(reason);
      },
      milliseconds,
    );
    controller.signal.addEventListener("abort", () => clearTimeout(timeoutId));

    return controller.signal;
  }

  // ブラウザ以外の環境では setTimeout の unref や FinalizationRegistry が必要になるため、
  // ポリフィルの実装コストが高い。`.timeout()` が無ければ諦めてエラーを投げる。
  throw new UnsupportedRuntimeError("AbortSignal.timeout() is not supported.");
}