Interface IValidationService

Data validation service.

Example

const validation = ctx.services.get<IValidationService>(CAPABILITIES.VALIDATION);
const result = validation.validate<User>(UserSchema, await ctx.request.json());
if (result.success) {
  save(result.value);
}

Since

0.1.0

interface IValidationService {
    middleware(
        schema: unknown,
        target: ValidationTarget,
        options?: ValidationMiddlewareOptions,
    ): MiddlewareFunction;
    validate<T>(
        schema: unknown,
        data: unknown,
    ): Result<T, readonly ValidationIssue[]>;
}

Implemented by

ValidationService

Index

Methods

middleware validate

Methods

middleware

middleware(
    schema: unknown,
    target: ValidationTarget,
    options?: ValidationMiddlewareOptions,
): MiddlewareFunction
Creates middleware that validates one part of the request and stores the parsed value in request state.
Parameters
- schema: unknown
  The schema (Zod schema by default)
- target: ValidationTarget
  Which request part to validate
- Optionaloptions: ValidationMiddlewareOptions
  Per-validator options. Optional, so a two-parameter implementation remains assignable; omitted means JSON-only bodies.
Returns MiddlewareFunction
The validation middleware
- Defined in packages/common/src/services/validation.ts:88

validate

validate<T>(
schema: unknown,
data: unknown,
): Result<T, readonly ValidationIssue[]>
Validates data against a schema.
Type Parameters
- T
  The validated output type
Parameters
- schema: unknown
  The schema (Zod schema by default)
- data: unknown
  The value to validate
Returns Result<T, readonly ValidationIssue[]>
Ok with the parsed value, or Err with the issues
- Defined in packages/common/src/services/validation.ts:77

Interface IValidationService

Example

Since

Implemented by

Index

Methods

Methods

middleware

Parameters

Returns MiddlewareFunction

validate

Type Parameters

Parameters

Returns Result<T, readonly ValidationIssue[]>

Settings

On This Page