Class SchemaError

Error thrown when schema validation fails.

Hierarchy

Error
- SchemaError

Index

Constructors

Properties

path expected received

Methods

missingField typeMismatch constraintViolation invalidEnum

Constructors

constructor

new SchemaError(
    message: string,
    path: string,
    expected: string,
    received?: unknown,
): SchemaError
Parameters
- message: string
- path: string
- expected: string
- Optionalreceived: unknown
Returns SchemaError
Overrides Error.constructor
- Defined in schema/errors.ts:18

Properties

`Readonly`path

path: string

The path to the field that failed validation

`Readonly`expected

expected: string

The expected type or constraint

`Readonly`received

received: unknown

The actual value received

Methods

`Static`missingField

missingField(path: string): SchemaError
Create error for missing required field.
Parameters
- path: string
Returns SchemaError
- Defined in schema/errors.ts:29

`Static`typeMismatch

typeMismatch(path: string, expected: string, received: unknown): SchemaError
Create error for type mismatch.
Parameters
- path: string
- expected: string
- received: unknown
Returns SchemaError
- Defined in schema/errors.ts:36

`Static`constraintViolation

constraintViolation(
    path: string,
    constraint: string,
    received: unknown,
): SchemaError
Create error for constraint violation.
Parameters
- path: string
- constraint: string
- received: unknown
Returns SchemaError
- Defined in schema/errors.ts:49

`Static`invalidEnum

invalidEnum(
    path: string,
    allowed: readonly unknown[],
    received: unknown,
): SchemaError
Create error for invalid enum value.
Parameters
- path: string
- allowed: readonly unknown[]
- received: unknown
Returns SchemaError
- Defined in schema/errors.ts:61