Class XrplError

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

Hierarchy

Error
- XrplError

Index

Constructors

Properties

data? message name stack? prepareStackTrace? stackTraceLimit

Methods

inspect toString captureStackTrace

Constructors

constructor

new XrplError(message?, data?): XrplError
Construct an XrplError.
Parameters
- message: string = ''
  
  The error message.
- Optional data: unknown
  
  The data that caused the error.
  
  Optional
Returns XrplError
Overrides Error.constructor
- Defined in packages/xrpl/src/errors.ts:19

Properties

`Optional` `Readonly` data

data?: unknown

`Readonly` message

message: string

`Readonly` 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

inspect

inspect(): string
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.
- Defined in packages/xrpl/src/errors.ts:52

toString

toString(): string
Converts the Error to a human-readable String form.

Returns string
The String output of the Error.
- Defined in packages/xrpl/src/errors.ts:36

`Static` captureStackTrace

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

Generated using TypeDoc