Skip to main content

Class: ValidationError

error.ValidationError

This error is thrown when a validation fails.

Hierarchy

  • Error

    ValidationError

Constructors

constructor

new ValidationError(«destructured»): ValidationError

Parameters

NameType
«destructured»ValidationErrorOptions

Returns

ValidationError

Overrides

Error.constructor

Defined in

src/error.ts:14

Properties

prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

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

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/.pnpm/@types+node@20.12.8/node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/.pnpm/@types+node@20.12.8/node_modules/@types/node/globals.d.ts:30


path

path: string[]

The path to the value that failed validation.

Defined in

src/error.ts:8


code

code: string

The error code.

Defined in

src/error.ts:10


message

message: string

The error message.

Overrides

Error.message

Defined in

src/error.ts:12


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1067


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1069


cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/.pnpm/@types+node@20.12.8/node_modules/@types/node/globals.d.ts:21