Loxer - v3.0.0
    Preparing search index...

    Class NamedError

    A customizable Error, that may be created from an existing Error

    Hierarchy

    • Error
      • NamedError
    Index
    • creates a new Error with the given name and message.

      • Additionally receives a givenError which will have concatenated message and stack with the newly created error.
      • If the givenError is not typeof Error an Error will be created of it.
      const existingError = new RangeError('some message')
      const myError = new NamedError('MyError', 'this is my custom Error', existingError);

      // in a try-catch-phrase
      try {
      // some dangerous stuff
      } catch (error) {
      Loxer.error(new NamedError('DangerousStuffError', 'failed to do some dangerous stuff', error));
      }

      Parameters

      • name: string

        The Error.name

      • message: string

        The Error.message which may be concatenated with the givenError.message

      • OptionalexistingError: unknown

        An optional error (of any type) which will be concatenated

      Returns NamedError

    cause?: unknown
    name: string
    message: string
    stack?: string
    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.

    • 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