Class ControllerError

Custom error class to standardize error handling in controllers. Includes a unique key, detailed message, and associated HTTP status code.

Hierarchy

  • Error
    • ControllerError

Constructors

constructor

Properties

httpStatus key message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new ControllerError(
        key: string,
        message?: string,
        httpStatus?: number,
    ): ControllerError

  • Constructor for the ControllerError class.

    Parameters

    • key: string

      A unique key identifying the error.

    • Optionalmessage: string

      An optional detailed message for the error. If not provided, a default message is generated using the key.

    • httpStatus: number = 400

      The HTTP status code for the error (default is 400 - Bad Request).

    Returns ControllerError

Properties

httpStatus

httpStatus: number

key

key: string

message

message: string

name

name: string

Optionalstack

stack?: string

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

StaticcaptureStackTrace

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

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods