Class IMXError

Custom Error class that is returned from the API when a request fails

Hierarchy

Error
- IMXError

Index

Constructors

Properties

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

Methods

captureStackTrace

Constructors

constructor

new IMXError(__namedParameters): IMXError
Parameters
- __namedParameters: APIError
Returns IMXError
Overrides Error.constructor
- Defined in packages/x-client/src/types/errors.ts:11

Properties

`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

`Readonly` code

code: string

`Optional` `Readonly` details

details?: string

name

name: string

message

message: string

`Optional` stack

stack?: string

`Optional` cause

cause?: unknown

Methods

`Static` captureStackTrace

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

Generated using TypeDoc