Skip to content

Commit bd6701e

Browse files
committed
Add info about exported types to README.md
1 parent 2646e64 commit bd6701e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,13 @@ Import `JsonSchema` type definition:
1919
```typescript
2020
import { JsonSchema } from '@fosfad/json-schema-typescript-definitions/2020-12';
2121
```
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

Comments
 (0)