Optionalcode: stringOptionalpath: stringOptionalcauseReadonlycodeStable machine-readable error code (omnist-spec Sec8.3), when the throw site has one.
ReadonlyerrorsDetailed list of structural or schema-conformance issues encountered.
ReadonlypathLocation of the error -- a line:col text-position path for lexical/syntax errors (Sec8.4), when known.
OptionalstackStaticstackThe 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.
StaticcaptureCreates 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();
OptionalconstructorOpt: FunctionStaticprepare
A document could not be read from its format (outside the supported profile).
Format-syntax failures (invalid JSON/YAML/TOML/XML text) carry only the message --
.errorsis empty. Schema-conformance failures frommaterializecarry the full structured list of every problem found (path, message, machine-readable code), not just the first one.codeandpathare optional and populated only where the throw site has a stable machine-readable code to offer (currently:oml.ts's lexer/parser errors, using theparse.*family fromomnist-specSec8.3.1, with aline:colpathper Sec8.4 -- see issue #108, the same "only the codes the actual grammar can produce" discipline #105 already used forSchemaError/osd.ts). Every otherParseErrorthrow site in this package continues to pass only a message (and, for materialize failures,errors); both fields are simplyundefinedthere. This is an additive widening of an existing public type, not a breaking change: no existing call site or catch site needs updating.