Class RedirectHttpError<TCode>

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

Type Parameters

TCode extends number = number

Hierarchy

HttpError<TCode>
- RedirectHttpError

Index

Constructors

Properties

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

Methods

generateMetadata captureStackTrace isInstance

Constructors

constructor

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

Properties

`Optional` `Readonly` cause

cause?: unknown

`Optional` `Readonly` details

details?: Dict<unknown>

`Readonly` errorCode

errorCode: string

`Readonly` location

location: string

message

message: string

name

name: string

`Optional` stack

stack?: string

`Readonly` statusCode

statusCode: TCode

`Static` `Optional` prepareStackTrace

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

generateMetadata

generateMetadata(subject: string | Quad_Subject): Quad[]
Returns quads representing metadata relevant to this error.
Parameters
- subject: string | Quad_Subject
Returns Quad[]
Inherited from HttpError.generateMetadata
- Defined in src/util/errors/HttpError.ts:54

`Static` captureStackTrace

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

`Static` isInstance

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