Optionalcode: stringOptionalpath: stringOptionalcauseReadonlycodeStable machine-readable error code (omnist-spec Sec8.3), when the throw site has one.
ReadonlypathLocation of the error -- a line:col text-position path for lexical 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
The schema text or structure is invalid.
codeandpathare optional and populated where the throw site has a stable machine-readable code to offer:osd.ts's lexical errors (theparse.*family, Sec8.3.1, with aline:colpathper Sec8.4) and every well-formedness failure (theschema.*family, Sec8.3.3, with a Schema path per Sec8.4.1; since #149). Public constructors (field(),record(),nullable()) carry thecodebut have no enclosing record to build a path from, sopathisundefinedthere unless the OSD parser orSchemasupplies it. Remaining throw sites (e.g. an invalid programmatic type) pass only a message. This is an additive widening of an existing public type, not a breaking change: no existing call site or catch site needs updating.