Class TimeoutError<T, E>

A TimeoutError.

Type Parameters

T = unknown
E = unknown

Hierarchy

CodedError<T, E>
- TimeoutError

Index

Constructors

Properties

cause? code detail? message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new TimeoutError<T, E>(message?, options?): TimeoutError<T, E>
Type Parameters
- T = unknown
- E = unknown
Parameters
- message: string = TimeoutError.name
- Optional options: ErrorDetailOptions<T>
Returns TimeoutError<T, E>
Overrides CodedError.constructor
- Defined in packages/commons/src/error/errors.ts:18

Properties

`Optional` `Readonly` cause

cause?: E

The error cause.

`Readonly` code

code: string

Thr error code.

`Optional` detail

detail?: T

Returns any data passed when initializing the error.

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

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

Type declaration

- (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

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

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

Generated using TypeDoc