@nevware21/tripwire - v0.1.2
    Preparing search index...

    Class AssertionFailure<T>

    This error is thrown when the requested assertion check fails.

    • Extends standard Error class

    The message for the error.

    The additional properties for the error.

    The function to use as the starting point for the stack trace.

    The new AssertionFailure instance.

    interface CustomProps {
        expected: number;
        actual: number;
    }

    try {
       throw new AssertionFailure<CustomProps>("Expected value does not match actual value", { expected: 1, actual: 2 });
    } catch (e) {
      console.error(e.fullStack);
      console.log(e.toJSON());
    }

    console.error(error.message); // "Expected value does not match actual value"
    console.log(error.props?.expected); // 1
    console.log(error.props?.actual); // 2

    Type Parameters

    • T

      The type of the additional properties.

    • Static Hideconstructor

      Creates a new AssertionFailure with the given message and properties.

      Type Parameters

      • T

        The type of the additional properties.

      Parameters

      • Optionalmessage: string

        The message for the error.

      • Optionalprops: T

        The additional properties for the error.

      • OptionalstackStart: Function | Function[]

        The function to use as the starting point for the stack trace.

      Returns AssertionFailure<T>

      The new AssertionFailure.

      try {
         throw new AssertionFailure("Assertion failed", { expected: 1, actual: 2 });
      } catch (e) {
        console.error(e.fullStack);
       console.log(e.toJSON());
      }
    • Static Hideconstructor

      Creates a new AssertionFailure with the given message and properties.

      Type Parameters

      • T

        The type of the additional properties.

      Parameters

      • Optionalmessage: string

        The message for the error.

      • OptionalinnerEx: Error

        The error that caused this error to be thrown.

      • Optionalprops: T

        The additional properties for the error.

      • OptionalstackStart: Function | Function[]

        The function to use as the starting point for the stack trace.

      Returns AssertionFailure<T>

      The new AssertionFailure.

      try {
         throw new AssertionFailure("Assertion failed", new Error(), { expected: 1, actual: 2 });
      } catch (e) {
        console.error(e.fullStack);
       console.log(e.toJSON());
      }
    • Static

      Creates a new AssertionError with the given message and properties.

      Type Parameters

      • T

        The type of the additional properties.

      Parameters

      • Optionalmessage: string

        The message for the error.

      • Optionalprops: T

        The additional properties for the error.

      • OptionalstackStart: Function | Function[]

        An array of possible functions to use as the starting point for the stack trace.

      Returns AssertionError<T>

      The new AssertionError.

    • Static

      Creates a new AssertionError with the given message and properties.

      Type Parameters

      • T

        The type of the additional properties.

      Parameters

      • Optionalmessage: string

        The message for the error.

      • OptionalinnerEx: Error

        The error that caused this error to be thrown.

      • Optionalprops: T

        The additional properties for the error.

      • OptionalstackStart: Function | Function[]

        An array of possible functions to use as the starting point for the stack trace.

      Returns AssertionError<T>

      The new AssertionError.

    • Static

      Parameters

      • Optionalmessage: string

      Returns AssertionError

    • Static

      Parameters

      • Optionalmessage: string

      Returns Error

    Index

    Properties

    message name props? stack? stackTraceLimit

    Accessors

    fullStack innerException

    Methods

    captureStackTrace prepareStackTrace toJSON

    Properties

    message: string
    name: string
    props?: T

    Additional properties that are included in the error.

    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.

    Accessors

    • get fullStack(): string

      Gets the full stack trace of the error, this will show all of the internal calls that lead to the error being thrown. Useful for debugging as generally the stack trace will only show the location where the error was thrown.

      Returns string

      The full stack trace as a string.

    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

    • Converts the error to a JSON object.

      Parameters

      • Optionalstack: boolean

        Whether to include the stack trace in the JSON object.

      Returns any

      A JSON representation of the error.

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods