Conversation
since it'll be a 2.0.0 anyway, might as well
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
1 participant
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.
Summary
Now
Eithercan be used to decode payloads which encode different types in the same field, without wrapping those fields in"left"/"right"sub-objects.The decoder now attempts to interpret a single‑value container as the left type, and if that fails, the right type. Of course, if both fail to decode, then a
NeitherLeftNorRightValueWasEncodederror is thrown just as always.{ "value": "foo" } // decodes to either.left("foo") { "value": 42 } // decodes to either.right(42)Usage notes
Since this only depends on which types the field can encode as, this will always decode as
.leftwhen the left and right types of theEitherare the same:{ "value": "foo" } // decodes to either.left("foo") { "value": "baz" } // decodes to either.left("baz")Breaking Changes
While this update preserves existing decoding paths while adding an additional path, it does remove an error which might have previously been thrown. In case any users of this library depended on that error to validate encoded data which doesn't match their desired format, this change is considered breaking and requires a MAJOR version bump.