Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpError<T>

A class for all errors that could be thrown by Solid. All errors inheriting from this should fix the status code thereby hiding the HTTP internals from other components.

Type parameters

  • T: number = number

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new HTTP error. Subclasses should call this with their fixed status code.

    Type parameters

    • T: number = number

    Parameters

    • statusCode: T

      HTTP status code needed for the HTTP response.

    • name: string

      Error name. Useful for logging and stack tracing.

    • Optional message: string

      Error message.

    • options: HttpErrorOptions = {}

      Optional options.

    Returns HttpError<T>

Properties

Optional Readonly cause

cause?: unknown

Optional Readonly details

details?: Dict<unknown>

Readonly errorCode

errorCode: string

message

message: string

name

name: string

Optional stack

stack?: string

Readonly statusCode

statusCode: T

Static Optional prepareStackTrace

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

Type declaration

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[]

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static isInstance

  • isInstance(error: any): error is HttpError<number>