@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
165 lines (76 loc) • 3 kB
Markdown
---
lang: en
title: 'API docs: rest.validationoptions'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
permalink: /doc/en/lb4/apidocs.rest.validationoptions.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/rest](./rest.md) > [ValidationOptions](./rest.validationoptions.md)
## ValidationOptions interface
Options for request body validation using AJV
**Signature:**
```typescript
export interface ValidationOptions extends AjvOptions
```
**Extends:** AjvOptions
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[ajvErrors?](./rest.validationoptions.ajverrors.md)
</td><td markdown="1">
</td><td markdown="1">
[AjvErrorOptions](./rest.ajverroroptions.md)
</td><td markdown="1">
_(Optional)_ Enable custom error messages in JSON-Schema for AJV validator from https://github.com/epoberezkin/ajv-errors - `true`<!-- -->: Enable `ajv-errors` - `AjvErrorOptions`<!-- -->: Enable `ajv-errors` with options
</td></tr>
<tr><td markdown="1">
[ajvErrorTransformer?](./rest.validationoptions.ajverrortransformer.md)
</td><td markdown="1">
</td><td markdown="1">
(errors: ErrorObject\[\]) => ErrorObject\[\]
</td><td markdown="1">
_(Optional)_ A function that transform the `ErrorObject`<!-- -->s reported by AJV. This could be used for error messages customization, localization, etc.
</td></tr>
<tr><td markdown="1">
[ajvFactory?](./rest.validationoptions.ajvfactory.md)
</td><td markdown="1">
</td><td markdown="1">
(options: AjvOptions) => Ajv
</td><td markdown="1">
_(Optional)_ A factory to create Ajv instance
</td></tr>
<tr><td markdown="1">
[ajvKeywords?](./rest.validationoptions.ajvkeywords.md)
</td><td markdown="1">
</td><td markdown="1">
string\[\]
</td><td markdown="1">
_(Optional)_ Enable additional AJV keywords from https://github.com/epoberezkin/ajv-keywords - `string[]`<!-- -->: Add an array of keywords from `ajv-keywords`
</td></tr>
<tr><td markdown="1">
[compiledSchemaCache?](./rest.validationoptions.compiledschemacache.md)
</td><td markdown="1">
</td><td markdown="1">
[SchemaValidatorCache](./rest.schemavalidatorcache.md)
</td><td markdown="1">
_(Optional)_ Custom cache for compiled schemas by AJV. This setting makes it possible to skip the default cache.
</td></tr>
<tr><td markdown="1">
[prohibitedKeys?](./rest.validationoptions.prohibitedkeys.md)
</td><td markdown="1">
</td><td markdown="1">
string\[\]
</td><td markdown="1">
_(Optional)_ An array of keys to be rejected, such as `__proto__`<!-- -->.
</td></tr>
</tbody></table>