Skip to main content
Version: 0.17.x

Class: TimeoutError

Defined in: src/errors/index.ts:188

Error for operation timeouts

Extends​

Constructors​

Constructor​

new TimeoutError(message, operationType?, timeoutMs?): TimeoutError

Defined in: src/errors/index.ts:192

Parameters​

message​

string

operationType?​

string = 'unknown'

timeoutMs?​

number = 0

Returns​

TimeoutError

Overrides​

FreshGuardError.constructor

Properties​

cause?​

optional cause: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

FreshGuardError.cause

code​

readonly code: string

Defined in: src/errors/index.ts:18

Inherited from​

FreshGuardError.code

debug?​

optional debug: DebugInfo

Defined in: src/errors/index.ts:22

Inherited from​

FreshGuardError.debug

debugId​

readonly debugId: string

Defined in: src/errors/index.ts:21

Inherited from​

FreshGuardError.debugId

message​

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

FreshGuardError.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

FreshGuardError.name

operationType​

readonly operationType: string

Defined in: src/errors/index.ts:189

sanitized​

readonly sanitized: boolean

Defined in: src/errors/index.ts:20

Inherited from​

FreshGuardError.sanitized

stack?​

optional stack: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

FreshGuardError.stack

timeoutMs​

readonly timeoutMs: number

Defined in: src/errors/index.ts:190

timestamp​

readonly timestamp: Date

Defined in: src/errors/index.ts:19

Inherited from​

FreshGuardError.timestamp

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.2.3/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

FreshGuardError.stackTraceLimit

Methods​

toJSON()​

toJSON(): object

Defined in: src/errors/index.ts:42

Convert error to JSON for logging

Returns​

object

Inherited from​

FreshGuardError.toJSON

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.2.3/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

FreshGuardError.captureStackTrace

connectionTimeout()​

static connectionTimeout(timeoutMs): TimeoutError

Defined in: src/errors/index.ts:226

Parameters​

timeoutMs​

number

Returns​

TimeoutError

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.2.3/node_modules/@types/node/globals.d.ts:55

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

FreshGuardError.prepareStackTrace

queryTimeout()​

static queryTimeout(timeoutMs): TimeoutError

Defined in: src/errors/index.ts:218

Parameters​

timeoutMs​

number

Returns​

TimeoutError