Class TimeoutError

Error thrown when xrpl.js times out.

Hierarchy

ConnectionError
- TimeoutError

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TimeoutError(message?: string, data?: unknown): TimeoutError

Inherited from ConnectionError.constructor
- Defined in ripple-lib/packages/xrpl/src/errors.ts:21
Construct an XrplError.

Parameters
- message: string = ''
  
  The error message.
- Optional data: unknown
  
  The data that caused the error.
Returns TimeoutError

Properties

Optional Readonly data

data?: unknown

Readonly message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  see
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

inspect(): string

Inherited from ConnectionError.inspect
- Defined in ripple-lib/packages/xrpl/src/errors.ts:54
Console.log in node uses util.inspect on object, and util.inspect allows us to customize its output: https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects.

Returns string
The String output of the Error.

toString

toString(): string

Inherited from ConnectionError.toString
- Defined in ripple-lib/packages/xrpl/src/errors.ts:38
Converts the Error to a human-readable String form.

Returns string
The String output of the Error.

Static captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void

Inherited from ConnectionError.captureStackTrace
- Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4
Create .stack property on a target object

Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void

Generated using TypeDoc