Skip to content

Commit

Permalink
Version 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Avaq committed May 7, 2020
1 parent 92ffbcc commit 1ec3e37
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 24 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The MIT License (MIT)
Copyright (c) 2019 Aldwin Vlasblom
Copyright (c) 2020 Aldwin Vlasblom

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ that were enhanced with a fluent method API. One can think of the
`Fluenture` type as a *subtype* of `Future`: any instances of it are also
instances of `Future`.

#### <a name="fluent" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L93">`fluent :: Future a b -⁠> Fluenture a b`</a>
#### <a name="fluent" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L95">`fluent :: Future a b -⁠> Fluenture a b`</a>

Enhance a Future with the fluent method API.

This function is idempotent.

#### <a name="functional" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L107">`functional :: Future a b -⁠> Future a b`</a>
#### <a name="functional" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L109">`functional :: Future a b -⁠> Future a b`</a>

Strip a fluent Future (or "Fluenture") from its method API.

This function is idempotent.

#### <a name="pipe" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L132">`pipe :: (Future a b -⁠> c) -⁠> c`</a>
#### <a name="pipe" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L134">`pipe :: (Future a b -⁠> c) -⁠> c`</a>

This function is equivalent to Fluture's built-in `pipe` function, with
once exception; If a Future is returned from the given function, it is
Expand All @@ -43,79 +43,87 @@ method chain intact.

Fluent [`pipe`](https://github.com/fluture-js/Fluture#pipe).

#### <a name="alt" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L146">`alt :: Fluenture a b ~> Future a b -⁠> Fluenture a b`</a>
#### <a name="alt" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L148">`alt :: Fluenture a b ~> Future a b -⁠> Fluenture a b`</a>

Fluent [`alt`](https://github.com/fluture-js/Fluture#alt).

#### <a name="and" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L151">`and :: Fluenture a b ~> Future a b -⁠> Fluenture a b`</a>
#### <a name="and" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L153">`and :: Fluenture a b ~> Future a b -⁠> Fluenture a b`</a>

Fluent [`and`](https://github.com/fluture-js/Fluture#and).

#### <a name="ap" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L156">`ap :: Fluenture a b ~> Future a (b -⁠> c) -⁠> Fluenture a c`</a>
#### <a name="ap" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L158">`ap :: Fluenture a b ~> Future a (b -⁠> c) -⁠> Fluenture a c`</a>

Fluent [`ap`](https://github.com/fluture-js/Fluture#ap).

#### <a name="bimap" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L161">`bimap :: Fluenture a b ~> (a -⁠> c, b -⁠> d) -⁠> Fluenture c d`</a>
#### <a name="bichain" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L163">`bichain :: Fluenture a b ~> (a -⁠> Fluenture a c, b -⁠> Fluenture a c) -⁠> Fluenture a c`</a>

Fluent [`bichain`](https://github.com/fluture-js/Fluture#bichain).

#### <a name="bimap" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L168">`bimap :: Fluenture a b ~> (a -⁠> c, b -⁠> d) -⁠> Fluenture c d`</a>

Fluent [`bimap`](https://github.com/fluture-js/Fluture#bimap).

#### <a name="both" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L166">`both :: Fluenture a b ~> Future a c -⁠> Fluenture a (Pair b c)`</a>
#### <a name="both" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L173">`both :: Fluenture a b ~> Future a c -⁠> Fluenture a (Pair b c)`</a>

Fluent [`both`](https://github.com/fluture-js/Fluture#both).

#### <a name="cache" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L171">`cache :: Fluenture a b ~> () -⁠> Fluenture a b`</a>
#### <a name="cache" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L178">`cache :: Fluenture a b ~> () -⁠> Fluenture a b`</a>

Fluent [`cache`](https://github.com/fluture-js/Fluture#cache).

#### <a name="chain" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L176">`chain :: Fluenture a b ~> (b -⁠> Fluenture a c) -⁠> Fluenture a c`</a>
#### <a name="chain" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L183">`chain :: Fluenture a b ~> (b -⁠> Fluenture a c) -⁠> Fluenture a c`</a>

Fluent [`chain`](https://github.com/fluture-js/Fluture#chain).

#### <a name="chainRej" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L181">`chainRej :: Fluenture a b ~> (a -⁠> Fluenture c b) -⁠> Fluenture c b`</a>
#### <a name="chainRej" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L188">`chainRej :: Fluenture a b ~> (a -⁠> Fluenture c b) -⁠> Fluenture c b`</a>

Fluent [`chainRej`](https://github.com/fluture-js/Fluture#chainRej).

#### <a name="coalesce" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L186">`coalesce :: Fluenture a b ~> (a -⁠> c, b -⁠> c) -⁠> Fluenture d c`</a>
#### <a name="coalesce" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L193">`coalesce :: Fluenture a b ~> (a -⁠> c, b -⁠> c) -⁠> Fluenture d c`</a>

Fluent [`coalesce`](https://github.com/fluture-js/Fluture#coalesce).

#### <a name="lastly" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L191">`lastly :: Fluenture a b ~> Future a c -⁠> Fluenture a b`</a>
#### <a name="lastly" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L198">`lastly :: Fluenture a b ~> Future a c -⁠> Fluenture a b`</a>

Fluent [`lastly`](https://github.com/fluture-js/Fluture#lastly).

#### <a name="map" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L196">`map :: Fluenture a b ~> (b -⁠> c) -⁠> Fluenture a c`</a>
#### <a name="map" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L203">`map :: Fluenture a b ~> (b -⁠> c) -⁠> Fluenture a c`</a>

Fluent [`map`](https://github.com/fluture-js/Fluture#map).

#### <a name="mapRej" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L201">`mapRej :: Fluenture a b ~> (a -⁠> c) -⁠> Fluenture c b`</a>
#### <a name="mapRej" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L208">`mapRej :: Fluenture a b ~> (a -⁠> c) -⁠> Fluenture c b`</a>

Fluent [`mapRej`](https://github.com/fluture-js/Fluture#mapRej).

#### <a name="race" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L206">`race :: Fluenture a b ~> Future a b -⁠> Fluenture a b`</a>
#### <a name="pap" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L213">`pap :: Fluenture a b ~> Fluenture a (b -⁠> c) -⁠> Fluenture a c`</a>

Fluent [`pap`](https://github.com/fluture-js/Fluture/#pap).

#### <a name="race" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L218">`race :: Fluenture a b ~> Future a b -⁠> Fluenture a b`</a>

Fluent [`race`](https://github.com/fluture-js/Fluture#race).

#### <a name="swap" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L211">`swap :: Fluenture a b ~> () -⁠> Fluenture b a`</a>
#### <a name="swap" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L223">`swap :: Fluenture a b ~> () -⁠> Fluenture b a`</a>

Fluent [`swap`](https://github.com/fluture-js/Fluture#swap).

#### <a name="done" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L216">`done :: Fluenture a b ~> (b -⁠> c) -⁠> Cancel`</a>
#### <a name="done" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L228">`done :: Fluenture a b ~> (b -⁠> c) -⁠> Cancel`</a>

Fluent [`done`](https://github.com/fluture-js/Fluture#done).

#### <a name="fork" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L221">`fork :: Fluenture a b ~> (a -⁠> c, b -⁠> d) -⁠> Cancel`</a>
#### <a name="fork" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L233">`fork :: Fluenture a b ~> (a -⁠> c, b -⁠> d) -⁠> Cancel`</a>

Fluent [`fork`](https://github.com/fluture-js/Fluture#fork).

#### <a name="forkCatch" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L226">`forkCatch :: Fluenture a b ~> (Error -⁠> c, a -⁠> d, b -⁠> e) -⁠> Cancel`</a>
#### <a name="forkCatch" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L238">`forkCatch :: Fluenture a b ~> (Error -⁠> c, a -⁠> d, b -⁠> e) -⁠> Cancel`</a>

Fluent [`forkCatch`](https://github.com/fluture-js/Fluture#forkCatch).

#### <a name="promise" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L231">`promise :: Fluenture Error a ~> () -⁠> Promise Error a`</a>
#### <a name="promise" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L243">`promise :: Fluenture Error a ~> () -⁠> Promise Error a`</a>

Fluent [`promise`](https://github.com/fluture-js/Fluture#promise).

#### <a name="value" href="https://github.com/fluture-js/fluenture/blob/v1.0.0/index.js#L236">`value :: Fluenture a b ~> ((Nullable a, b) -⁠> c) -⁠> Cancel`</a>
#### <a name="value" href="https://github.com/fluture-js/fluenture/blob/v2.0.0/index.js#L248">`value :: Fluenture a b ~> ((Nullable a, b) -⁠> c) -⁠> Cancel`</a>

Fluent [`value`](https://github.com/fluture-js/Fluture#value).

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fluenture",
"version": "1.0.0",
"version": "2.0.0",
"description": "Bring back Fluture's fluent method API",
"tags": [
"fluent",
Expand Down

0 comments on commit 1ec3e37

Please sign in to comment.