Skip to content

Commit

Permalink
feat(do): Add do operator
Browse files Browse the repository at this point in the history
  • Loading branch information
kofno committed Jun 10, 2018
1 parent dec4cac commit 988e718
Show file tree
Hide file tree
Showing 13 changed files with 296 additions and 118 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js

Large diffs are not rendered by default.

68 changes: 57 additions & 11 deletions docs/classes/_err_.err.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ <h3>Methods</h3>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="_err_.err.html#ap" class="tsd-kind-icon">ap</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="_err_.err.html#assign" class="tsd-kind-icon">assign</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="_err_.err.html#cata" class="tsd-kind-icon">cata</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_err_.err.html#do" class="tsd-kind-icon">do</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_err_.err.html#getorelse" class="tsd-kind-icon">get<wbr>OrElse</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_err_.err.html#getorelsevalue" class="tsd-kind-icon">get<wbr>OrElse<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="_err_.err.html#map" class="tsd-kind-icon">map</a></li>
Expand All @@ -138,7 +139,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L4">Err.ts:4</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L4">Err.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -160,7 +161,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> error</h3>
<div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">E</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L5">Err.ts:5</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L5">Err.ts:5</a></li>
</ul>
</aside>
</section>
Expand All @@ -178,7 +179,7 @@ <h3>and<wbr>Then</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#andthen">andThen</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L25">Err.ts:25</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L25">Err.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -226,7 +227,7 @@ <h3>ap</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#ap">ap</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L37">Err.ts:37</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L37">Err.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -259,7 +260,7 @@ <h3>assign</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#assign">assign</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L41">Err.ts:41</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L41">Err.ts:41</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -295,7 +296,7 @@ <h3>cata</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#cata">cata</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L33">Err.ts:33</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L33">Err.ts:33</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand All @@ -314,6 +315,48 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">B</span><
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="do" class="tsd-anchor"></a>
<h3>do</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">do<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_result_.result.html" class="tsd-signature-type">Result</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">E</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#do">do</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L48">Err.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <span class="tsd-signature-type">A</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_result_.result.html" class="tsd-signature-type">Result</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">E</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="getorelse" class="tsd-anchor"></a>
<h3>get<wbr>OrElse</h3>
Expand All @@ -325,7 +368,7 @@ <h3>get<wbr>OrElse</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#getorelse">getOrElse</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L9">Err.ts:9</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L9">Err.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -361,7 +404,7 @@ <h3>get<wbr>OrElse<wbr>Value</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#getorelsevalue">getOrElseValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L13">Err.ts:13</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L13">Err.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -385,7 +428,7 @@ <h3>map</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#map">map</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L17">Err.ts:17</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L17">Err.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -433,7 +476,7 @@ <h3>map<wbr>Error</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#maperror">mapError</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L21">Err.ts:21</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L21">Err.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -481,7 +524,7 @@ <h3>or<wbr>Else</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_result_.result.html">Result</a>.<a href="_result_.result.html#orelse">orElse</a></p>
<ul>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/61ed660/src/Err.ts#L29">Err.ts:29</a></li>
<li>Defined in <a href="https://github.com/kofno/resulty/blob/dec4cac/src/Err.ts#L29">Err.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -568,6 +611,9 @@ <h4 class="tsd-returns-title">Returns <a href="_result_.result.html" class="tsd-
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a href="_err_.err.html#cata" class="tsd-kind-icon">cata</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="_err_.err.html#do" class="tsd-kind-icon">do</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="_err_.err.html#getorelse" class="tsd-kind-icon">get<wbr>OrElse</a>
</li>
Expand Down
Loading

0 comments on commit 988e718

Please sign in to comment.