Class XrplError

Base Error class for xrpl.js. All Errors thrown by xrpl.js should throw XrplErrors.

Hierarchy

Error
- XrplError

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overrides Error.constructor
- Defined in src/errors.ts:23
Construct an XrplError.

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

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
  
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

inspect(): string

- Defined in src/errors.ts:53
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

- Defined in src/errors.ts:37
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 Error.captureStackTrace
- Defined in 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