Minima.js

Appearance

Minima.js API

Minima.js API / @minimajs/schema / / ValidationError

Class: ValidationError ​

Defined in: packages/schema/src/error.ts:35

Custom validation error class for schema validation failures. Extends the base HTTP error with validation-specific properties and methods. Provides integration with Zod validation errors and enhanced error reporting.

Extends ​

Constructors ​

Constructor ​

ts
new ValidationError(message, extend): ValidationError;

Defined in: packages/schema/src/error.ts:95

Creates a new ValidationError instance.

Parameters ​

message ​

string

extend ​

ValidatorErrorOptions = {}

Returns ​

ValidationError

Example ​

ts
const error = new ValidationError('Validation failed');

Overrides ​

HttpError.constructor

Properties ​

base? ​

ts
optional base: unknown;

Defined in: packages/server/lib/error.d.ts:43

Inherited from ​

HttpError.base

cause? ​

ts
optional cause: unknown;

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

The cause of the error.

Inherited from ​

HttpError.cause

code? ​

ts
optional code: string;

Defined in: packages/server/lib/error.d.ts:26

Inherited from ​

HttpError.code

constructor ​

ts
constructor: typeof HttpError;

Defined in: packages/server/lib/error.d.ts:45

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Inherited from ​

ts
BaseError.constructor

headers? ​

ts
optional headers: HeadersInit;

Defined in: packages/server/lib/error.d.ts:44

Inherited from ​

HttpError.headers

issues? ​

ts
optional issues: $ZodIssue[];

Defined in: packages/schema/src/error.ts:37

Array of zod issues

message ​

ts
message: string;

Defined in: packages/schema/src/error.ts:96

Inherited from ​

HttpError.message

name ​

ts
name: string = ValidationError.name;

Defined in: packages/schema/src/error.ts:85

The name of this error class

Overrides ​

HttpError.name

response ​

ts
response: unknown;

Defined in: packages/server/lib/error.d.ts:42

Inherited from ​

HttpError.response

stack? ​

ts
optional stack: string;

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from ​

HttpError.stack

status ​

ts
status: number;

Defined in: packages/server/lib/error.d.ts:41

Inherited from ​

HttpError.status

stackTraceLimit ​

ts
static stackTraceLimit: number;

Defined in: node_modules/.bun/@types+node@25.0.5/node_modules/@types/node/globals.d.ts:67

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 ​

HttpError.stackTraceLimit

Methods ​

render() ​

ts
render(ctx): Promise<Response>;

Defined in: packages/server/lib/error.d.ts:48

Parameters ​

ctx ​

Context

Returns ​

Promise<Response>

Inherited from ​

HttpError.render

toJSON() ​

ts
toJSON(): unknown;

Defined in: packages/server/lib/error.d.ts:47

Returns ​

unknown

Inherited from ​

HttpError.toJSON

captureStackTrace() ​

ts
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@25.0.5/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
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:

js
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 ​

targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

HttpError.captureStackTrace

create() ​

ts
static create(err, status?): HttpError<string>;

Defined in: packages/server/lib/error.d.ts:40

Parameters ​

err ​

unknown

status? ​

number

Returns ​

HttpError<string>

Inherited from ​

HttpError.create

createFromZodError() ​

ts
static createFromZodError(error): ValidationError;

Defined in: packages/schema/src/error.ts:54

Creates a ValidationError from a ZodError. Recursively converts nested validation errors.

Parameters ​

error ​

ZodError

Returns ​

ValidationError

Example ​

ts
try {
  await schema.parse(data);
} catch (err) {
  if (err instanceof ZodError) {
    const validationError = ValidationError.createFromZodError(err);
    throw validationError;
  }
}

is() ​

ts
static is(value): value is HttpError<unknown>;

Defined in: packages/server/lib/error.d.ts:39

Parameters ​

value ​

unknown

Returns ​

value is HttpError<unknown>

Inherited from ​

HttpError.is

isError() ​

ts
static isError(error): error is Error;

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters ​

error ​

unknown

Returns ​

error is Error

Inherited from ​

HttpError.isError

prepareStackTrace() ​

ts
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@25.0.5/node_modules/@types/node/globals.d.ts:55

Parameters ​

err ​

Error

stackTraces ​

CallSite[]

Returns ​

any

See ​

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

Inherited from ​

HttpError.prepareStackTrace

toJSON() ​

ts
static toJSON(err): unknown;

Defined in: packages/schema/src/error.ts:80

Serializes a ValidationError to JSON for HTTP responses.

Parameters ​

err ​

ValidationError

Returns ​

unknown

Throws ​

AssertionError if err is not a ValidationError instance

Example ​

ts
const json = ValidationError.toJSON(error);
// {
//   "message": "Validation failed for 'email'",
//   "issues": [
//     {
//       "code": "invalid_type",
//       "expected": "string",
//       "received": "undefined",
//       "path": ["email"],
//       "message": "Required"
//     }
//   ]
// }

Overrides ​

ts
BaseError.toJSON