Result

Result: object;

Utility namespace for constructing Result values.

Only ok and err are provided. Error accumulation within a single validator is done imperatively (errors.push(...)) to keep the surface area minimal.

Type Declaration

err()

readonly err<T, E>(errors): Result<T, E>;

Wraps errors in a Result.

Type Parameters

Type Parameter	Default type
T	never
E	ValidationIssue[]

Parameters

Parameter	Type
errors	E

Returns

Result<T, E>

Example

return Result.err<Address, ValidationIssue[]>(errors);

ok()

readonly ok<T, E>(value): Result<T, E>;

Wraps a successful value in a Result.

Explicit type parameters are required to satisfy TypeScript 7’s stricter variance checks when the result is used in a union context.

Type Parameters

Type Parameter	Default type
T	-
E	never

Parameters

Parameter	Type
value	T

Returns

Result<T, E>

Example

return Result.ok<Address, ValidationIssue[]>(parsed);