@omnist-dev/omnist
    Preparing search index...

    Class SchemaError

    The schema text or structure is invalid.

    code and path are optional and populated only where the throw site has a stable machine-readable code to offer (currently: osd.ts's lexical/tokenization errors, using the parse.* family from omnist-spec Sec8.3.1 -- extended by spec#46 to cover OSD's own lexing stage the same way it already covered OML's -- with a line:col path per Sec8.4). Every other SchemaError throw site in this package continues to pass only a message; both fields are simply undefined there. This is an additive widening of an existing public type, not a breaking change: no existing call site or catch site needs updating.

    Hierarchy (View Summary)

    Index
    cause?: unknown
    code: string | undefined

    Stable machine-readable error code (omnist-spec Sec8.3), when the throw site has one.

    message: string
    name: string
    path: string | undefined

    Location of the error -- a line:col text-position path for lexical errors (Sec8.4), when known.

    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