Add READMEs for All, Any and Arrow types #148
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
1 similar comment
evilsoft
commented
Nov 8, 2017
src/All/README.md
Outdated
| `concat` is used to combine (2) `Semigroup`s of the same type under an operation specified by the `Semigroup`. In the case of `All`, it will combine the two using logical AND (conjunction). | ||
|
|
||
| ```js | ||
| All(true).concat(All(true)) //=> All false |
There was a problem hiding this comment.
This should result to All true
src/All/README.md
Outdated
| All(false).concat(All(false)) //=> All false | ||
| ``` | ||
|
|
||
| ### value |
There was a problem hiding this comment.
might as well name these to valueOf
due to: this PR
src/Any/README.md
Outdated
|
|
||
| `empty` provides the identity for the `Monoid` in that when the value it provides is `concat`ed to any other value, it will return the other value. In the case of `Any` the result of `empty` is `false`. `empty` is available on both the Constructor and the Instance for convenience. | ||
| ```js | ||
| Any.empty() //=> Any true |
src/Any/README.md
Outdated
| isSameType(Any, Any) //=> true | ||
| isSameType(Any(false), Assign) //=> false | ||
|
|
||
| //=> false |
src/Any/README.md
Outdated
| Any(false).concat(Any(false)) //=> Any false | ||
| ``` | ||
|
|
||
| ### value |
There was a problem hiding this comment.
might as well name these to valueOf
due to: this PR
src/Arrow/README.md
Outdated
| .runWith({ value: '23' }) //=> 10 | ||
|
|
||
| arrAdd10Value | ||
| .runWith({ num: '23' }) //=> 10 |
src/Arrow/README.md
Outdated
| Arrow(x => x.toUpperCase()) | ||
|
|
||
| arrToUpper | ||
| .runWith('burrito bounce') //=> 'BURRITO BOUNCE' |
src/Arrow/README.md
Outdated
| Arrow a b ~> ((c -> a), (b -> d)) -> Arrow c d | ||
| ``` | ||
|
|
||
| `promap` can be used to adapt BOTH ends of an `Arrow` allow for existing `Arrow`s |
There was a problem hiding this comment.
allowing for existing Arrows
src/Arrow/README.md
Outdated
| ``` | ||
|
|
||
| `promap` can be used to adapt BOTH ends of an `Arrow` allow for existing `Arrow`s | ||
| to be reused in places in a flow where the types so not line up. It combines both |
src/Arrow/README.md
Outdated
| const arrDoubleAndAdd = | ||
| arrDouble | ||
| .both() | ||
| .map(merge((x, y) => x + y)) |
There was a problem hiding this comment.
use the add function here.
|
Actually I am okay with these examples. They are not so bad. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Seems like an OKAY start
These are the first in a series of Readmes to be added. This is another step in the Quest for monorepo.
Both
AllandAnydid not require any API changes, while there was no need to keepvalueforArrowas it no longer is used as a "traditional"Monoidas it was beforeCategorywas a thing.This is a BREAKING API change. No depreciation, just dropping it.