Class ApiError

Error class for errors that associated with unsuccessful HTTP responses. It's throw by API category REST API handlers and GraphQL query handlers for now.

Hierarchy (view full)

Constructors

constructor

Properties

message metadata? name recoverySuggestion? stack? underlyingError? prepareStackTrace? stackTraceLimit

Accessors

response

Methods

captureStackTrace

Constructors

constructor

Properties

message

message: string

Optional Readonly metadata

metadata?: ResponseMetadata

Additional metadata that can be used to provide more context to the error.

name

name: string

Optional Readonly recoverySuggestion

recoverySuggestion?: string

Optional stack

stack?: string

Optional Readonly underlyingError

underlyingError?: unknown

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Accessors

response

  • get response(): undefined | ApiErrorResponse

  • The unwrapped HTTP response causing the given API error.

    Returns undefined | ApiErrorResponse

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: Object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page