Optionaloptions: { cause?: unknown }Readonly[OptionalcauseReadonlyreportWhich fields disagreed with the schema, by path and type. Paste-able into a bug report.
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.
Static[hasStaticcaptureCreates 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 request succeeded, but the response is not what the endpoint's schema describes.
Covers both ways that can happen: the response was not JSON at all, or it parsed as JSON and its shape had drifted. The two are told apart by
cause— a validation failure carries the underlyingZodError, a non-JSON response carries nothing — whilereportsays which fields disagreed either way.They are one error rather than two on purpose: from a caller's side both mean "the API answered 2xx and the value cannot be trusted", and nobody should have to know which validator this library uses in order to catch that.
reportnames paths and types and never the values at them. The previous version of this error carried the entire response body, which put issue summaries, display names and custom field contents into every log line and error tracker that saw it — a schema bug turning into someone else's data incident.Distinct from
ApiError, which means the request itself failed.