Class ApiError

This class helps distinguish "user" errors (such as calling a method of this library without a required parameter) from remote API errors. When a remote API error occurs (i.e., the server responds with a 4xx or 5xx) an ApiError is thrown.

An ApiError will have a status property with the response's HTTP status code, and a message property with the response body (error message).

Example

try {
  await api.getUnreadCounts()
} catch (error) {
  if (error instanceof ApiError) {
    console.log("Caught an ApiError:")
    console.log(`HTTP ${error.status}: ${error.message}`)
  } else {
    console.log("Some other error:", error)
  }

Hierarchy

  • Error
    • ApiError

Constructors

constructor

Methods

captureStackTrace

Properties

prepareStackTrace? stackTraceLimit cause? name message stack? status

Constructors

constructor

  • new ApiError(message: string, status: number): ApiError

  • Parameters

    • message: string
    • status: number

    Returns ApiError

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Properties

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Optionalcause

cause?: unknown

name

name: string

message

message: string

Optionalstack

stack?: string

status

status: number

The HTTP status code of the response.

Settings

On This Page

Constructors
Methods
Properties