Function promiseWithTimeout

  • promiseWithTimeout<T>(
        ms: number,
        promise: Promise<T> | Promise<T>[],
        options?: { signal?: AbortSignal; timeoutError?: string },
    ): Promise<T>

    Returns a promise that resolves successfully if completed before the given timeout, otherwise rejects with a TimeoutError

    Type Parameters

    • T

    Parameters

    • ms: number

      The number of milliseconds to wait before timing out

    • promise: Promise<T> | Promise<T>[]

      A single Promise or array of Promises to wait for

    • Optionaloptions: { signal?: AbortSignal; timeoutError?: string }

      Configuration options

      • Optionalsignal?: AbortSignal

        Optional AbortSignal to cancel the timeout

      • OptionaltimeoutError?: string

        Custom error message for timeout

    Returns Promise<T>

    A Promise that resolves with the result of the input promise(s)

    Throws

    If the promise(s) don't complete within the specified timeout

    Throws

    If the operation is cancelled via AbortSignal

    Example

    // Single promise with 5 second timeout
    const result = await promiseWithTimeout(5000, fetchData());

    // Multiple promises with custom error message
    const results = await promiseWithTimeout(
      10000,
      [fetchData1(), fetchData2()],
      { timeoutError: "Failed to fetch data in time" }
    );

    // With abort signal
    const controller = new AbortController();
    const result = await promiseWithTimeout(5000, fetchData(), {
      signal: controller.signal
    });
    // Later: controller.abort();

    Remarks

    • Uses Promise.race() internally to compete between the actual promise(s) and a timeout promise
    • The timeout promise uses unref() to avoid keeping the Node.js process alive
    • Supports cancellation via AbortSignal
    • Cleans up resources when the promise resolves, rejects, or is cancelled

Settings

Member Visibility