@tgsnake/skema
    Preparing search index...

    Class SecurityCheckMismatch

    Error raised when an assertion check for key, signature, or padding lengths fails.

    SecurityCheckMismatch.check(serverNonce === expectedNonce, 'Nonce mismatch');
    

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    cause?: unknown

    The cause of the error.

    description?: string

    Detailed human-readable description offering troubleshooting steps or context.

    message: string = 'A security check mismatch has occurred.'

    The message string describing this error.

    name: 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.

    Methods

    • Serializes the error object to a clean JSON-compatible representation.

      Returns { [key: string]: unknown }

      A plain object containing error properties and the stack trace.

      Correctly stringifies extremely large fields (e.g. bigints) that are normally not serializable in standard JSON.stringify calls.

    • Formats the error into a structured string.

      Returns string

      A string starting with the constructor name followed by a pretty JSON payload.

    • 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

    • Asserts that a condition is true, throwing a SecurityCheckMismatch if it is not.

      Parameters

      • cond: boolean

        The boolean condition to evaluate.

      • Optionaldescription: string

        Detailed error message if assertion fails.

      Returns void

      If the condition is false.

    • 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