OptionalcauseReadonlycodeStable kind, safe to compare against a literal and to send over a
wire. Rides on Skipped.code when a run reports rather than throws.
OptionalstackStatic ReadonlycodeThe literal a subclass overrides. Read via new.target, not this.
StaticstackThe 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
Base class for every error this package throws.
Why there is a
codebesidenameinstanceofis the right discriminator when a consumer catches. ButrununderonError: 'skip' | 'collect'does not hand the error back — it reports aSkippedrecord — and a consumer branching its UI on the failure kind (a dropped feed column is a dimmed chip; a bad persisted param is a broken one) then has only prose to go on (Tidal,docs/notes/tidal-process-adoption-friction-2026-08.md).Every subclass annotates
codeas: stringrather than letting the literal type be inferred. Without it the static's type is the literal —ParamError.code: 'ParamError'— and a consumer subclassing to add its own code fails to compile with TS2417, which would make this additive field a source break for anyone already extending these classes (Codex, PR #667).codeis that discriminator, and it is a literal string per class rather thanconstructor.namebecause a consumer's minifier may rename the class — leavingnameas't'in a production build, silently, which is exactly the shape of bug the string exists to let them avoid. Declared once as astatic, read here throughnew.target, so a subclass states its code on one line.