-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature: Better docs and utility functions #12
Merged
Merged
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
seangwright
added
documentation
Improvements or additions to documentation
enhancement
New feature or request
tests
Unit or integration tests
labels
Sep 11, 2022
KyleMcMaster
previously approved these changes
Sep 20, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good! Lots to digest here but the docs and examples make it easy to see how this might be used for a consumer's domain. 👍 Left just a few suggestions on possible typos I noticed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
tests
Unit or integration tests
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.
Library
1.4.0
Docs
ResultAsync
andMaybeAsync
are still missing examplesREADME.md
README.md
Maybe
Maybe
utitlity factory functions:zeroAsNone
,emptyStringAsNone
,emptyOrWhiteSpaceStringAsNone
Maybe
since they might not be usedMaybe
convertsnull
/undefined
to 'no value'MaybeAsync
MaybeAsync.from
to acceptnull
/undefined
valuesMaybeAsync
into existing codegetValueOrDefault
andgetValueOrThrow
toMaybeAsync
Utilities
noop
utility method and expose it as public APImatch
to pass a value throughNotes
I tested updating Jest to Jest 29 broke it the custom assertions/matchers used by this library. I investigated the issue for awhile but was unable to figure out the right combination of hacks. It seems like the ecosystem is full of outdated information and a simple solution still hasn't been figured out.
See: jestjs/jest#12267 and jestjs/jest#12424
For now I'm staying on the latest of Jest 28, which works fine.