sumFlat - Encodes sum types with single record fields in one object
#65
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.
Let's say we have a PureScript Sum type, each case has either no fields or a single record field:
This PR introduces two new functions :
sumFlatandsumFlatWith. They works similar tosumandsumWIth.However for each constructor a
JPropCodec(or unit) must be provided.sumFlatuses a default encoding, whereas sumFlat can be passed custom encoding options.In the custom options a type level symbol can be given that represents a case discriminator in the JSON. (usually "type", "kind", "tag"...)
This codec can then be used as usual:
It will encode as follows:
{ "tag": "Baz", "active": true, "count": 42, "name": "hello" }It's verified at compile time that the record fields don't conflict with the custom tag. So in this example, if you exchange "name" with "tag" in the type definition, the compilation will fail.