Skip to content
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.

Sign up for GitHub

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

Add Either docs #324

Merged
merged 7 commits into from
Oct 19, 2018
Merged

Add Either docs #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6c6d4b3
add Either skeleton and update Sum Type links
Jul 29, 2018
62dc95f
add code examples
evilsoft Jul 29, 2018
da4b5e2
add some text to the sections
Oct 13, 2018
64f7174
add code examples for Either transformation functions
evilsoft Oct 14, 2018
e58ff96
address PR comments for Either docs
evilsoft Oct 18, 2018
feee1fa
Merge branch 'master' into docs/Either
evilsoft Oct 18, 2018
de9a947
Merge branch 'master' into docs/Either
evilsoft Oct 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions docs/src/pages/docs/crocks/Async.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1266,17 +1266,19 @@ eitherToAsync :: Either b a -> Async b a
eitherToAsync :: (a -> Either c b) -> a -> Async c b
```

Used to transform a given `Either` instance to
an `Async` instance, `eitherToAsync` will turn a `Right` instance into
Used to transform a given [`Either`][either] instance to
an `Async` instance, `eitherToAsync` will turn a [`Right`][right] instance into
a [`Resolved`](#resolved) instance wrapping the original value contained in the
original `Right`. If a `Left` is provided, then `eitherToAsync` will return
a [`Rejected`](#rejected) instance, wrapping the original `Left` value.
original [`Right`][right]. If a [`Left`][left] is provided,
then `eitherToAsync` will return a [`Rejected`](#rejected) instance, wrapping
the original [`Left`][left] value.

Like all `crocks` transformation functions, `eitherToAsync` has two possible
signatures and will behave differently when passed either an `Either` instance
or a function that returns an instance of `Either`. When passed the instance,
a transformed `Async` is returned. When passed an `Either` returning function,
a function will be returned that takes a given value and returns an `Async`.
signatures and will behave differently when passed
an [`Either`][either] instance or a function that returns an instance
of [`Either`][either]. When passed the instance, a transformed `Async` is
returned. When passed an [`Either`][either] returning function, a function will
be returned that takes a given value and returns an `Async`.

<!-- eslint-disable no-console -->
<!-- eslint-disable no-sequences -->
Expand Down Expand Up @@ -1678,6 +1680,9 @@ Resolved('103')
[identity]: ../functions/combinators.html#identity
[first]: ../monoids/First.html
[last]: ../monoids/Last.html
[maybe]: ../crocks/Maybe.html
[just]: ../crocks/Maybe.html#just
[nothing]: ../crocks/Maybe.html#nothing
[maybe]: ./Maybe.html
[just]: ./Maybe.html#just
[nothing]: ./Maybe.html#nothing
[either]: ./Either.html
[left]: ./Either.html#left
[right]: ./Either.html#right
Loading