#Class: TimeoutError

Error thrown when an operation exceeds its time budget.

Thrown by withTimeout and waitFor. Use instanceof TimeoutError (or check error.name === 'TimeoutError') to distinguish a timeout from an execution failure — e.g. inside RetryOptions.shouldRetry.

#Extends

• Error

#Constructors

#Constructor

new TimeoutError(ms, message?): TimeoutError

#Parameters

#ms

number

#message?

string

#Returns

TimeoutError

#Overrides

Error.constructor

#Properties

#cause?

optional cause?: unknown

#Inherited from

Error.cause

---

#message

message: string

#Inherited from

Error.message

---

#ms

readonly ms: number

The time budget that was exceeded, in milliseconds.

---

#name

name: string

#Inherited from

Error.name

---

#stack?

optional stack?: string

#Inherited from

Error.stack

---

#prepareStackTrace?

static optional prepareStackTrace?: (err, stackTraces) => any

Optional override for formatting stack traces

#Parameters

#err

Error

#stackTraces

CallSite[]

#Returns

any

#See

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

#Inherited from

Error.prepareStackTrace

---

#stackTraceLimit

static stackTraceLimit: number

#Inherited from

Error.stackTraceLimit

#Methods

#captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

#Parameters

#targetObject

object

#constructorOpt?

Function

#Returns

void

#Inherited from

Error.captureStackTrace