Class HttpError

A general HTTP error.

Hierarchy

Error
- HttpError

Index

Constructors

Properties

body? code contentType? headers? json message name stack? statusCode statusMessage prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new HttpError(
    statusCode: number,
    statusMessage: string,
    body?: string,
    contentType?: string,
    headers?: HttpHeaders,
    message?: string,
): HttpError
Parameters
- statusCode: number
- statusMessage: string
- Optionalbody: string
- OptionalcontentType: string
- Optionalheaders: HttpHeaders
- Optionalmessage: string
Returns HttpError
Overrides Error.constructor
- Defined in packages/client/src/errors.ts:23

Properties

`Optional` `Readonly`body

body?: string

code

code: string

application error code, when available

`Optional` `Readonly`contentType

contentType?: string

`Optional` `Readonly`headers

headers?: HttpHeaders

json

json: any

json error response

message

message: string

name

name: string

`Optional`stack

stack?: string

`Readonly`statusCode

statusCode: number

`Readonly`statusMessage

statusMessage: string

`Static` `Optional`prepareStackTrace

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

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136