@snups/rjsf-validator-ajv8
Version:
The ajv-8 based validator for @snups/rjsf-core
14 lines (13 loc) • 1.12 kB
TypeScript
import { RJSFSchema, StrictRJSFSchema } from '@snups/rjsf-utils';
import { CustomValidatorOptionsType } from './types.js';
/** The function used to compile a schema into javascript code in the form that allows it to be used as a precompiled
* validator. The main reasons for using a precompiled validator is reducing code size, improving validation speed and,
* most importantly, avoiding dynamic code compilation when prohibited by a browser's Content Security Policy. For more
* information about AJV code compilation see: https://ajv.js.org/standalone.html
*
* @param schema - The schema to be compiled into a set of precompiled validators functions
* @param [options={}] - The set of `CustomValidatorOptionsType` information used to alter the AJV validator used for
* compiling the schema. They are the same options that are passed to the `customizeValidator()` function in
* order to modify the behavior of the regular AJV-based validator.
*/
export declare function compileSchemaValidatorsCode<S extends StrictRJSFSchema = RJSFSchema>(schema: S, options?: CustomValidatorOptionsType): string;