Loosen the is check for optionalized
#737
Merged
+21
−2
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
andrew-scott-fischer
requested changes
Apr 11, 2024
BREAKING CHANGE: explicit undefined properties are now accepted when encoding
bitgopatmcl
force-pushed
the
looser-exact-optional-check
branch
from
7534874
to
416bca2
Compare
andrew-scott-fischer
approved these changes
Apr 12, 2024
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
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 breaking change at 06eddbb introduced a codec that bahaves like
partialbut strips explicitundefinedproperties when decoding and encoding. This is only used byoptionalized, and it turns out it is broken at runtime, particularly in codebases that don't setexactOptionalPropertyTypes. It defaults to off, and much code treats "key not present" and "key set toundefined" interchangeably. Some combinators inio-tssuch asunionrely onisto determine which codec to use when encoding, so when anoptionalizedcodec is used in a union, and is passed an object with defined-undefined properties to encode, it results in an exception. This change fixes that by loosening up the runtimeischeck.BREAKING CHANGE: explicit undefined properties are now accepted by
optionalized.is