Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RestError

Package version

A custom error type for failed pipeline requests.

Hierarchy

  • any
    • RestError

Index

Constructors

constructor

Properties

Optional code

code: undefined | string

The code of the error itself (use statics on RestError if possible.)

Optional details

details: unknown

Bonus property set by the throw site.

Optional request

The request that was made.

Optional response

The response received (if any.)

Optional statusCode

statusCode: undefined | number

The HTTP status code of the request (if applicable.)

Static PARSE_ERROR

PARSE_ERROR: string = "PARSE_ERROR"

This means that parsing the response from the server failed. It may have been malformed.

Static REQUEST_SEND_ERROR

REQUEST_SEND_ERROR: string = "REQUEST_SEND_ERROR"

Something went wrong when making the request. This means the actual request failed for some reason, such as a DNS issue or the connection being lost.

Methods

[custom]

  • [custom](): string

Generated using TypeDoc