UNPKG

@loopback/docs

Version:
35 lines (24 loc) 2.15 kB
--- lang: en title: 'API docs: rest.requestbodyvalidationoptions' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar editurl: https://github.com/strongloop/loopback-next/tree/master/packages/rest permalink: /doc/en/lb4/apidocs.rest.requestbodyvalidationoptions.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [RequestBodyValidationOptions](./rest.requestbodyvalidationoptions.md) ## RequestBodyValidationOptions interface Options for request body validation using AJV <b>Signature:</b> ```typescript export interface RequestBodyValidationOptions extends ajv.Options ``` ## Properties | Property | Type | Description | | --- | --- | --- | | [ajvErrors](./rest.requestbodyvalidationoptions.ajverrors.md) | <code>true &#124; AjvErrorOptions</code> | Enable custom error messages in JSON-Schema for AJV validator from https://github.com/epoberezkin/ajv-errors - <code>true</code>: Enable <code>ajv-errors</code> - <code>AjvErrorOptions</code>: Enable <code>ajv-errors</code> with options | | [ajvErrorTransformer](./rest.requestbodyvalidationoptions.ajverrortransformer.md) | <code>(errors: ajv.ErrorObject[]) =&gt; ajv.ErrorObject[]</code> | A function that transform the <code>ErrorObject</code>s reported by AJV. This could be used for error messages customization, localization, etc. | | [ajvFactory](./rest.requestbodyvalidationoptions.ajvfactory.md) | <code>(options: ajv.Options) =&gt; Ajv</code> | A factory to create Ajv instance | | [ajvKeywords](./rest.requestbodyvalidationoptions.ajvkeywords.md) | <code>true &#124; string[]</code> | Enable additional AJV keywords from https://github.com/epoberezkin/ajv-keywords - <code>true</code>: Add all keywords from <code>ajv-keywords</code> - <code>string[]</code>: Add an array of keywords from <code>ajv-keywords</code> | | [compiledSchemaCache](./rest.requestbodyvalidationoptions.compiledschemacache.md) | <code>SchemaValidatorCache</code> | Custom cache for compiled schemas by AJV. This setting makes it possible to skip the default cache. |