Class ProcedureTimedOutError

When thrown, indicates that the request timed out waiting for the operation to complete.

Hierarchy

ProcedureError
- ProcedureTimedOutError

Index

Constructors

Properties

code data? message name

Constructors

constructor

new ProcedureTimedOutError(message??: string, data?: Record<string, unknown>): ProcedureTimedOutError
Initializes an instance of ProcedureTimedOutError.
Parameters
- Optional message: string = 'Timed out waiting for the operation to complete.'
  
  A string indicating the cause of the error.
- Optional data: Record<string, unknown>
  
  An optional dictionary of data which will be passed to a procedure's caller when thrown.
Returns ProcedureTimedOutError
Overrides ProcedureError.constructor
- Defined in src/errors.ts:132

Properties

code

code: ProcedureErrorCodes = ProcedureErrorCodes.TIMED_OUT

The code used to identify the error type.

`Optional` data

data?: Record<string, unknown>

An optional dictionary of data which will be passed to a procedure's caller when thrown.

message

message: string

A string indicating the cause of the error.

name

name: string = 'ProcedureTimedOutError'

The name of the error type.

Generated using TypeDoc