Class: SchemaMismatchError

Defined in: src/core/errors/schemaMismatchError.ts:22

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 underlying ZodError, a non-JSON response carries nothing — while report says 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.

report names 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.

Extends

• Error

Constructors

Constructor

new SchemaMismatchError(
   message, 
   report, 
   options?
): SchemaMismatchError;

Defined in: src/core/errors/schemaMismatchError.ts:28

Parameters

Parameter	Type
message	string
report	SchemaMismatchReport
options?	{ cause?: unknown; }
options.cause?	unknown

Returns

SchemaMismatchError

Overrides

Error.constructor

Properties

[ERROR_KINDS]

readonly [ERROR_KINDS]: readonly ErrorKind[];

Defined in: src/core/errors/schemaMismatchError.ts:23

---

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

---

message

message: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

name

name: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

---

report

readonly report: SchemaMismatchReport;

Defined in: src/core/errors/schemaMismatchError.ts:26

Which fields disagreed with the schema, by path and type. Paste-able into a bug report.

---

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@types+node@22.20.1/node_modules/@types/node/globals.d.ts:68

The 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.

Inherited from

Error.stackTraceLimit

Methods

[hasInstance]()

static hasInstance: boolean;

Defined in: src/core/errors/schemaMismatchError.ts:35

Parameters

Parameter	Type
value	unknown

Returns

boolean

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.20.1/node_modules/@types/node/globals.d.ts:52

Creates 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();

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.20.1/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace