v4 fix: Made field-less Schema.Struct({}) respect onExcessProperty: 'ignore' | 'preserve' | 'error'#6434
Open
nikelborm wants to merge 1 commit into
Open
Conversation
…ore' | 'preserve' | 'error'
🦋 Changeset detectedLatest commit: f7f13e0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 27 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
5 tasks
nikelborm
changed the title
Schema.Struct({}) respect onExcessProperty: 'ignore' | 'preserve' | 'error'
5 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Type
Description
Motivation: you remove one field in the schema; the decoded object gets fewer fields. You remove another; fewer again. You remove the last; suddenly, all the fields come back, regardless of the default
onExcessProperty: "ignore". If the user wants to retrieve all fields, they can setonExcessProperty: "preserve".I tried to defend old behaviour with "
{}meanstypeof obj === 'object' && obj !== nulland effect's schema tries to be closer to TypeScript's behaviour, by treatingSchema.Struct({})as something passing the condition". And this might hold in isolation. But considering the context, by this logic, any fields which are not explicitly mentioned inSchema.Struct({ ... })should be preserved in all decoded objects, not only the ones that have{}signature, to follow TypeScript's assignability rules. And this is not what happens. The behavior should be consistent between field-less and field-ful structs.Related
Schema.Struct({})respectonExcessProperty: 'ignore' | 'preserve' | 'error'#6298