ModelInputError

Thrown by a factory when its input violates the model’s construction-time contract. The peer of Pydantic’s ValidationError on the Python side — parity is of the invariant, not of the exception class.

Extends

Error

Constructors

Constructor

new ModelInputError(kind: ModelKind, problem: ModelInputProblem): ModelInputError

Parameters

Parameter	Type
`kind`	`ModelKind`
`problem`	`ModelInputProblem`

Returns

ModelInputError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	‐	`Error.cause`
`kind`	`readonly`	`ModelKind`	‐	‐
`message`	`public`	`string`	‐	`Error.message`
`name`	`public`	`string`	‐	`Error.name`
`problem`	`readonly`	`ModelInputProblem`	‐	‐
`stack?`	`public`	`string`	‐	`Error.stack`
`stackTraceLimit`	`static`	`number`	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.	`Error.stackTraceLimit`

Methods

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void

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: Error, stackTraces: CallSite[]): any

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace