common-stuff
    Preparing search index...

    Class HttpError

    HTTP error class with status code

    // Throw 404 error with default message
    throw new HttpError(404)
    throw new HttpError(HttpStatusCodes.NOT_FOUND)

    // Throw 404 error with custom message
    throw new HttpError(404, 'X not found')
    throw new HttpError(HttpStatusCodes.NOT_FOUND, 'X not found')

    // Throw 500 error and expose custom message to user
    throw new HttpError(HttpStatusCodes.INTERNAL_SERVER_ERROR, 'Missing configuration', {expose: true})

    // Handle HttpError
    if (err instanceof HttpError) {
        console.log(err.message)
        return err.publicMessage
    }

    Hierarchy

    • Error
      • HttpError
    Index

    Constructors

    constructor

    Properties

    cause? expose message name publicMessage stack? status stackTraceLimit

    Methods

    captureStackTrace isError prepareStackTrace

    Constructors

    • Parameters

      • status: number

        HTTP status code

      • Optionalmessage: string

        error message, if not provided message from [[HttpStatusReasons]] is used

      • Optionalproperties: { expose: boolean }

        additional configuration

        • expose: boolean

          Should error message be exposed to the user

      Returns HttpError

      Error if status is not supported

    Properties

    cause?: unknown
    expose: boolean

    Should error message be exposed to the user

    message: string
    name: string
    publicMessage: string

    this.message if this.status is true else message from [[HttpStatusReasons]] is used

    stack?: string
    status: number

    HTTP status code

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods