use satisfies instead of direct type for JSONSchema #1002
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TypeScript 4.9 introduced
satisfies
, which solves an old typing pain point forJSONSchema
. Refer to the TypeScript documentation for an explanation.Note it is just a documentation change, direct typing still works.
Below is an example from this library of the difference between direct typing and
satisfies
:Note that there is still some type widening happening. The best solution would be:
Thus the schema is kept fully intact, without any type widening, while still having autocomplete and type check.