AjvService

@tsed/ajv

Usage

import { AjvService } from "@tsed/ajv";

See /packages/specs/ajv/src/services/AjvService.ts.

Overview

class AjvService {
    readonly name = "ajv";
    protected errorFormatter: ErrorFormatter;
    protected returnsCoercedValues: boolean | undefined;
    protected ajv: Ajv;
    validate<TReturn = never, TValue = unknown>(value: TValue, options: AjvValidateOptions | JsonSchema): Promise<[TReturn] extends [never] ? TValue : TReturn>;
    protected mapOptions(options: AjvValidateOptions | JsonSchema): AjvValidateOptions;
    protected mapErrors(errors: ErrorObject[], options: any): AjvValidationError;
    protected mapClassError(error: AjvErrorObject, targetType: Type<any>): string | undefined;
}

readonly name

readonly name = "ajv";

protected errorFormatter

protected errorFormatter: ErrorFormatter;

protected returnsCoercedValues

protected returnsCoercedValues: boolean | undefined;

protected ajv

protected ajv: Ajv;

validate

validate<TReturn = never, TValue = unknown>(value: TValue, options: AjvValidateOptions | JsonSchema): Promise<[TReturn] extends [never] ? TValue : TReturn>;

• value (TValue): Value to validate.

• options (AjvValidateOptions | JsonSchema): Validation options or JsonSchema.

Validate a value against a JSON schema, a model type, or explicit AJV options.

The return type is inferred from value by default and can be overridden with an explicit generic: ajvService.validate<MyType>(value, options).

If returnsCoercedValues is enabled globally or in options, coercions performed by AJV are returned.

protected mapOptions

protected mapOptions(options: AjvValidateOptions | JsonSchema): AjvValidateOptions;

protected mapErrors

protected mapErrors(errors: ErrorObject[], options: any): AjvValidationError;

protected mapClassError

protected mapClassError(error: AjvErrorObject, targetType: Type<any>): string | undefined;