Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove redundant docs on TypeBox properties #4095

Merged
merged 2 commits into from Jun 30, 2022
Merged

Remove redundant docs on TypeBox properties #4095

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
819a486
Remove redundant docs on TypeBox properties
simonplend Jun 29, 2022
bfc5835
Remove Ajv customOptions from code example
simonplend Jun 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 1 addition & 15 deletions docs/Reference/Type-Providers.md
View file
Open in desktop
Expand Up @@ -70,14 +70,7 @@ import { Type } from '@sinclair/typebox'

import fastify from 'fastify'

const server = fastify({
ajv: {
customOptions: {
strict: 'log',
keywords: ['kind', 'modifier'],
},
},
}).withTypeProvider<TypeBoxTypeProvider>()
const server = fastify().withTypeProvider<TypeBoxTypeProvider>()

server.get('/route', {
schema: {
Expand All @@ -94,13 +87,6 @@ server.get('/route', {
})
```

TypeBox uses the properties `kind` and `modifier` internally. These properties
are not strictly valid JSON schema which will cause `AJV@7` and newer versions
to throw an invalid schema error. To remove the error it's either necessary to
omit the properties by using
[`Type.Strict()`](https://github.com/sinclairzx81/typebox#strict) or use the AJV
options for adding custom keywords.

See also the [TypeBox
documentation](https://github.com/sinclairzx81/typebox#validation) on how to set
up AJV to work with TypeBox.
Expand Down