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 extends number = number

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Methods

generateMetadata captureStackTrace isInstance

Constructors

constructor

  • new HttpError<T>(statusCode, name, message?, options?): HttpError<T>

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

    Type Parameters

    • T extends number = number

    Parameters

    • statusCode: T

      HTTP status code needed for the HTTP response.

    • name: string

      Error name. Useful for logging and stack tracing.

    • Optionalmessage: string

      Error message.

    • options: HttpErrorOptions = {}

      Optional options.

    Returns HttpError<T>

Properties

Optional Readonlycause

cause?: unknown

ReadonlyerrorCode

errorCode: string

message

message: string

Readonlymetadata

metadata: RepresentationMetadata

name

name: string

Optionalstack

stack?: string

ReadonlystatusCode

statusCode: T

Static OptionalprepareStackTrace

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

Optional override for formatting stack traces

See

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

StaticstackTraceLimit

stackTraceLimit: number

Methods

ProtectedgenerateMetadata

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

StaticisInstance

Settings

Member Visibility

On This Page

Constructors
Properties
Methods