Skip to main content

validation

const validation: object

Kanon V3 lightweight validation helpers (Zod-like ergonomics, minimal surface).

Type Declaration​

parse(): {<T>(schema, value): T; <S>(schema, value): Infer<S>; } = validationParse​

Call Signature: > <T>(schema, value): T​

Parses a value and throws on failure.


Type Parameters​
T: T​

schema: Schema<T>
value: unknown
Returns: T

Since​

2.0.0

Call Signature: > <S>(schema, value): Infer<S>​

Parses a value and throws on failure.

Type Parameters​
S: S extends GenericSchema​

schema: S
value: unknown
Returns: Infer<S>

Since​

2.0.0

safeParse(): {<T>(schema, value): SafeParseResult<T>; <S>(schema, value): SafeParseResult<Infer<S>>; } = validationSafeParse​

Call Signature: > <T>(schema, value): SafeParseResult<T>​

Parses a value and returns a discriminated result.

Type Parameters​
T: T​

schema: Schema<T>
value: unknown
Returns: SafeParseResult<T>

Since​

2.0.0

Call Signature: > <S>(schema, value): SafeParseResult<Infer<S>>​

Parses a value and returns a discriminated result.

Type Parameters​
S: S extends GenericSchema​

schema: S
value: unknown
Returns: SafeParseResult<Infer<S>>

Since​

2.0.0

parseAsync(): {<T>(schema, value): Promise<T>; <S>(schema, value): Promise<Infer<S>>; } = validationParseAsync​

Call Signature: > <T>(schema, value): Promise<T>​

Async variant of parse, kept for API parity (logic stays sync).

Type Parameters​
T: T​

schema: Schema<T>
value: unknown
Returns: Promise<T>

Since​

2.0.0

Call Signature: > <S>(schema, value): Promise<Infer<S>>​

Async variant of parse, kept for API parity (logic stays sync).

Type Parameters​
S: S extends GenericSchema​

schema: S
value: unknown
Returns: Promise<Infer<S>>

Since​

2.0.0

safeParseAsync(): {<T>(schema, value): Promise<SafeParseResult<T>>; <S>(schema, value): Promise<SafeParseResult<Infer<S>>>; } = validationSafeParseAsync​

Call Signature: > <T>(schema, value): Promise<SafeParseResult<T>>​

Async variant of safeParse, kept for API parity (logic stays sync).

Type Parameters​
T: T​

schema: Schema<T>
value: unknown
Returns: Promise<SafeParseResult<T>>

Since​

2.0.0

Call Signature: > <S>(schema, value): Promise<SafeParseResult<Infer<S>>>​

Async variant of safeParse, kept for API parity (logic stays sync).

Type Parameters​
S: S extends GenericSchema​

schema: S
value: unknown
Returns: Promise<SafeParseResult<Infer<S>>>

Since​

2.0.0