Class HttpRequestError

The error that is thrown to indicate a failed HTTP request, usually indicated by status code.

Hierarchy

Error
- HttpRequestError

Index

Constructors

Properties

cause? message name requestUrl? response? responseBody? stack? statusCode? statusText? url? prepareStackTrace? stackTraceLimit

Methods

toString captureStackTrace fromResponse

Constructors

constructor

new HttpRequestError(
message?: string,
options?: HttpRequestErrorOptions,
): HttpRequestError
Parameters
- Optionalmessage: string
- Optionaloptions: HttpRequestErrorOptions
Returns HttpRequestError
Overrides Error.constructor
- Defined in packages/jscorlib/src/http/httpRequestError.ts:21

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string = "HttpRequestError"

`Optional` `Readonly`requestUrl

requestUrl?: string

`Optional` `Readonly`response

response?: Response

`Optional` `Readonly`responseBody

responseBody?: string

`Optional`stack

stack?: string

`Optional` `Readonly`statusCode

statusCode?: number

`Optional` `Readonly`statusText

statusText?: string

`Optional` `Readonly`url

url?: 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

toString

toString(): string
Returns string
Inherited from Error.toString
- Defined in packages/@jscorlib-repo/linters/src/type-shims.d.ts:10

`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

`Static`fromResponse

fromResponse(
response: Response,
options?: HttpRequestErrorOptions,
): Promise<HttpRequestError>
Parameters
- response: Response
- Optionaloptions: HttpRequestErrorOptions
Returns Promise<HttpRequestError>
- Defined in packages/jscorlib/src/http/httpRequestError.ts:30