@alextheman/utility - v4.3.5
    Preparing search index...

    Class DataError

    Represents errors you may get that may've been caused by a specific piece of data.

    Hierarchy

    • Error
      • DataError
    Index

    Constructors

    • Parameters

      • data: unknown

        The data that caused the error.

      • code: string = "INVALID_DATA"

        A standardised code (e.g. UNEXPECTED_DATA).

      • message: string = "The data provided is invalid"

        A human-readable error message (e.g. The data provided is invalid).

      • Optionaloptions: ErrorOptions

        Extra options to pass to super Error constructor.

      Returns DataError

    Properties

    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

    • Checks whether the given input may have been caused by a DataError.

      Parameters

      • input: unknown

        The input to check.

      Returns input is DataError

      true if the input is a DataError, and false otherwise. The type of the input will also be narrowed down to DataError if true.