Update project documentation to account for typed errors #80
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.
What does this pull request do?
Updates the README to account for the new typed errors implementation in #73.
Other Notes:
I also made a pair of other small updates.
parseJson
function that parsesString -> Either JsonDecodeError Json
. This is mostly for convenience -- it's possible to just usejsonParser
fromargonaut-core
and thenlmap (TypeMismatch "JSON")
, but I think this is a bit much to expect a regular user to have to bikeshed about in their codebase. Providing a function that getsJson
from aString
and which is already compatible with the decoders seems like the way to go. It's calledparseJson
to avoid a name conflict withjsonParser
.Errors
module toError
, as it only defines a single error type and exports it.