Make JsonRecord type safe #1693
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
dtslint failed in CI; locally it was only running up to TS 4.1. Looks like the library isn't pinned so I had an outdated version. |
IIRC there's a |
|
@gcanti Ah, that's definitely something to enable generally (and does fix the accessing problem). Thanks. It doesn't, however, get around gcanti/io-ts#628 (comment). Should I close this and reopen gcanti/io-ts#639? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
JsonRecordtype currently allows you to access any string key, but this isn't type safe. Looking at the commit history the type came from microsoft/TypeScript#1897 (comment), and does seem to have been copied over to many other libraries.This PR changes the values of a
JsonRecordto also possibly beundefined, covering the fact that the key might not be set.This does mean that it's possible to set keys as
undefined, even though this type doesn't exist in JSON (stringifywill throw these keys away). This actually fixes my problem in gcanti/io-ts#628 (comment) (which was complicated to try and get round in gcanti/io-ts#639).