We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 2646e64 commit bd6701eCopy full SHA for bd6701e
README.md
@@ -19,3 +19,13 @@ Import `JsonSchema` type definition:
19
```typescript
20
import { JsonSchema } from '@fosfad/json-schema-typescript-definitions/2020-12';
21
```
22
+
23
+## Documentation
24
25
+### Exported types
26
27
+The package exports 3 types: `JsonSchemaBoolean`, `JsonSchemaObject` and `JsonSchema`:
28
29
+- `JsonSchemaBoolean` stands for [Boolean JSON Schema](https://json-schema.org/draft/2020-12/json-schema-core.html#rfc.section.4.3.2);
30
+- `JsonSchemaObject` is an object with all possible JSON Schema keywords within;
31
+- `JsonSchema` is a union type between `JsonSchemaBoolean` and `JsonSchemaObject`.
0 commit comments