Function timeout

Alias

  • timeout(ms): Promise<never>

  • Returns a promise that rejects with a TimeoutError after a specified delay.

    Parameters

    • ms: number

      The delay duration in milliseconds.

    Returns Promise<never>

    A promise that rejects with a TimeoutError after the specified delay.

    Throws

    Throws a TimeoutError after the specified delay.

    Example

    try {
      await timeout(1000); // Timeout exception after 1 second
    } catch (error) {
      console.error(error); // Will log 'The operation was timed out'
    }

Settings

Member Visibility