ReadonlycauseReadonlykindDiscriminated tag for exhaustive matching.
ReadonlynodeOptionalstackReadonlyvalueStaticstackThe 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
Raised when a value staged via
tx.set(node, value)fails the caller-suppliedinvariantregistered ongraph.input(id, initial, { invariant }).Remarks
Fires inside the commit staging phase, before recompute settles and before time advances. The full commit is rolled back atomically:
graph.nowdoes not advance, the commitLog does not grow, and no per-node or per-commit subscriber fires. Same atomicity shape as the existing structural-invariant errors (CycleError, NotAnInputNodeError, etc.) — invariants extend the engine's typed-failure surface from structural-only to caller-supplied value-level guards.The original throw from the user's invariant body is preserved as
cause(perError.cause's ES2022 contract) so adopters cane.cause instanceof TypeErrorto branch on validation modes.Param: nodeId
Id of the input whose staged write failed.
Param: value
The offending staged value.
Param: cause
The error thrown by the user's invariant body.