Class AptosApiError

The type returned from an API error

Param: name

the error name "AptosApiError"

Param: url

the url the request was made to

Param: status

the response status. i.e. 400

Param: statusText

the response message

Param: data

the response data

Param: request

the AptosRequest

Hierarchy

Error
- AptosApiError

Index

Constructors

Properties

data message name request stack? status statusText url prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new AptosApiError(request, response, message): AptosApiError
Parameters
- request: AptosRequest
- response: AptosResponse<any, any>
- message: string
Returns AptosApiError
Overrides Error.constructor
- Defined in src/client/types.ts:48

Properties

`Readonly` data

data: any

message

message: string

name

name: string

`Readonly` request

request: AptosRequest

`Optional` stack

stack?: string

`Readonly` status

status: number

`Readonly` statusText

statusText: string

`Readonly` url

url: 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

`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/.pnpm/@types+node@20.10.4/node_modules/@types/node/globals.d.ts:21

Generated using TypeDoc