DWS Packages
    Preparing search index...

    Class LocalizedHttpException<TCause>

    HTTP exception that carries translated messages.

    The message property contains the raw template for the default locale. Use resolveMessage to get the interpolated string for any locale.

    Type Parameters

    • const TCause = unknown

      Type of the underlying cause.

    Hierarchy

    • HttpException<TCause>
      • LocalizedHttpException
    Index

    Constructors

    Properties

    cause: TCause | undefined

    Original error or value that triggered this exception.

    date: Date

    Timestamp of when this exception was created.

    defaultLocale: string

    Locale used to build the default message string.

    httpStatusCode: number

    Resolved numeric HTTP status code (e.g. 404).

    key: string | undefined

    Application-specific error key (e.g. 'auth.tokenExpired').

    message: string
    name: string
    params: Readonly<Record<string, string>> | undefined

    Parameter values interpolated into {{placeholder}} tokens.

    stack?: string
    translations: Translations

    All available translations keyed by locale.

    uuid: string

    Unique identifier (UUID v7) for this exception instance.

    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

    • Create .stack property on a target object

      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

    • Check if a value is an instance of Error

      Parameters

      • value: unknown

        The value to check

      Returns value is Error

      True if the value is an instance of Error, false otherwise

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any