Class TimeoutError

Error thrown when a timeout occurs while waiting for a condition.

Hierarchy

Error
- TimeoutError

Index

Constructors

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new TimeoutError(timeoutInMs?: number): TimeoutError
Creates a new TimeoutError instance.
Parameters
- OptionaltimeoutInMs: number
  The timeout duration in milliseconds, if provided.
Returns TimeoutError
Example
```
throw new TimeoutError(5000);
// Throws: Timed out after waiting for 5000 ms
```
Overrides Error.constructor
- Defined in src/index.ts:22

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string

`Optional`stack

stack?: string

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static`stackTraceLimit

stackTraceLimit: number

Methods

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136