Skip to content
New issue

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

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

Already on GitHub? # to your account

chore: reconcile with upstream/main #3

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Prev Previous commit
Next Next commit
chore: update README to reflect updated features and others in-flight
  • Loading branch information
pdfowler committed Aug 4, 2023
commit 1a0b210d46586313a70c1fb2e8a39a333504ea8c
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -197,7 +197,7 @@ whats already implemented and what is missing.
- [x] Type.Literal() via "const" property
- [x] Type.Union() via "anyOf" property
- [x] Type.Intersect() via "allOf" property
- [x] Type.Enum() via "enum" property
- [x] Type.Union() via "enum" property
- [x] OneOf() via "oneOf" property
- This adds oneOf to the typebox type registry as (Kind: 'ExtendedOneOf') in
order to be able to align to oneOf json schema semantics and still be able
@@ -211,6 +211,14 @@ whats already implemented and what is missing.
- [ ] (low prio) Type.Tuple() via "array" instance type with minimalItems,
maximalItems and additionalItems false

#### To Be Prioritized
Support for the following types and functionality is being split from PR #23 into individual PRs
- [ ] Type.Enum() via "enum" property
- [ ] Type.Array() with "array<enum>" instance type
- [ ] Nullable Literal types, eg: `type: ['string', 'null']`
- [ ] "Unknown" object types
- [ ] Disambiguation of overlapping property names in nested schemas

## DEV/CONTRIBUTOR NOTES

- If you have an idea or want to help implement something, feel free to do so.