Class RedirectHttpError<TCode>

An error corresponding to a 3xx status code. Includes the location it redirects to.

Type Parameters

TCode extends number = number

Hierarchy (view full)

HttpError<TCode>
- RedirectHttpError

Index

Constructors

Properties

cause? errorCode location message metadata name stack? statusCode prepareStackTrace? stackTraceLimit

Methods

generateMetadata captureStackTrace isInstance

Constructors

constructor

new RedirectHttpError<TCode>(statusCode, name, location, message?, options?): RedirectHttpError<TCode>
Type Parameters
- TCode extends number = number
Parameters
- statusCode: TCode
- name: string
- location: string
- Optionalmessage: string
- Optionaloptions: HttpErrorOptions
Returns RedirectHttpError<TCode>
Overrides HttpError.constructor
- Defined in src/util/errors/RedirectHttpError.ts:13

Properties

`Optional` `Readonly`cause

cause?: unknown

`Readonly`errorCode

errorCode: string

`Readonly`location

location: string

message

message: string

`Readonly`metadata

metadata: RepresentationMetadata

name

name: string

`Optional`stack

stack?: string

`Readonly`statusCode

statusCode: TCode

`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

`Protected`generateMetadata

generateMetadata(): void
Initializes the error metadata.

Returns void
Inherited from HttpError.generateMetadata
- Defined in src/util/errors/HttpError.ts:57

`Static`captureStackTrace

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

`Static`isInstance

isInstance(error): error is RedirectHttpError<number>
Parameters
- error: unknown
Returns error is RedirectHttpError<number>
Overrides HttpError.isInstance
- Defined in src/util/errors/RedirectHttpError.ts:19