Class ApiError

An error answered by the server with a status and a message: thrown by endpoints and middlewares on the server (estuary-rpc-server answers it as { status: "error", message } with its status), and by estuary-rpc-client when a call is answered so, with the status kept.

Example

if (!book) throw new ApiError(HTTP_STATUS_CODES.NOT_FOUND, "No such book");

Hierarchy

  • Error
    • ApiError

Constructors

constructor

Properties

message name stack? status prepareStackTrace? stackTraceLimit

Methods

captureStackTrace is

Constructors

constructor

  • Parameters

    • status: number
    • Optional message: string

    Returns ApiError

Properties

message

message: string

name

name: string

Optional stack

stack?: string

Readonly status

status: number

Static Optional prepareStackTrace

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

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static is

  • Whether a value is an ApiError, even one made by another copy of estuary-rpc (two installs, or a bundler's copy beside Node's), where instanceof says no.

    Parameters

    • error: unknown

    Returns error is ApiError

Settings

Member Visibility

Theme

Generated using TypeDoc