Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@adjsky
adjsky committed Mar 10, 2024
1 parent 14436d3 commit 81a58a7
Show file tree
Hide file tree
Showing 16 changed files with 377 additions and 288 deletions.
129 changes: 71 additions & 58 deletions docs/classes/Err.html
View file

Large diffs are not rendered by default.

129 changes: 71 additions & 58 deletions docs/classes/Ok.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/classes/ResultError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ResultError</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/utility.ts:19</li></ul></aside>
<li>Defined in packages/resulto/src/utility.ts:31</li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -62,14 +62,14 @@ <h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-typ
<h4 class="tsd-returns-title">Returns <a href="ResultError.html" class="tsd-signature-type tsd-kind-class">ResultError</a></h4><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in packages/resulto/src/utility.ts:22</li></ul></aside></li></ul></section></section>
<li>Defined in packages/resulto/src/utility.ts:34</li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/utility.ts:20</li></ul></aside></section>
<li>Defined in packages/resulto/src/utility.ts:32</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/combine.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h5><span class="tsd-kind-parameter">results</span>: <span class="tsd-signature-
<h4 class="tsd-returns-title">Returns <a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/UnwrapOks.html" class="tsd-signature-type tsd-kind-type-alias">UnwrapOks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><a href="../types/UnwrapErrs.html" class="tsd-signature-type tsd-kind-type-alias">UnwrapErrs</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/result.ts:702</li></ul></aside></li></ul></section></div>
<li>Defined in packages/resulto/src/result.ts:808</li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/err-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h5><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-ty
<h4 class="tsd-returns-title">Returns <a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">E</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/result.ts:650</li></ul></aside></li></ul></section></div>
<li>Defined in packages/resulto/src/result.ts:756</li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/errAsync.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h5><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-ty
<h4 class="tsd-returns-title">Returns <a href="../types/AsyncResult.html" class="tsd-signature-type tsd-kind-type-alias">AsyncResult</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">E</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/result.ts:657</li></ul></aside></li></ul></section></div>
<li>Defined in packages/resulto/src/result.ts:763</li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/fromPromise.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <a href="../types/AsyncResult.html" class="tsd-signature-type tsd-kind-type-alias">AsyncResult</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">E</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/result.ts:670</li></ul></aside></li></ul></section></div>
<li>Defined in packages/resulto/src/result.ts:776</li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/fromThrowable.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">E</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/result.ts:684</li></ul></aside></li></ul></section></div>
<li>Defined in packages/resulto/src/result.ts:790</li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/ok-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-ty
<h4 class="tsd-returns-title">Returns <a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">E</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/result.ts:634</li></ul></aside></li></ul></section></div>
<li>Defined in packages/resulto/src/result.ts:740</li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/okAsync.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-ty
<h4 class="tsd-returns-title">Returns <a href="../types/AsyncResult.html" class="tsd-signature-type tsd-kind-type-alias">AsyncResult</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">E</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in packages/resulto/src/result.ts:641</li></ul></aside></li></ul></section></div>
<li>Defined in packages/resulto/src/result.ts:747</li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<h2>resulto</h2></div>
<div class="tsd-panel tsd-typography"><a id="md:resulto" class="tsd-anchor"></a><h1><a href="#md:resulto"><code>resulto</code></a></h1><p><a href="https://bundlephobia.com/package/resulto"><img src="https://img.shields.io/bundlephobia/minzip/resulto?label=bundle%20size&style=flat&colorA=000000&colorB=000000" alt="Build Size"></a>
<a href="https://www.npmjs.com/package/resulto"><img src="https://img.shields.io/npm/v/resulto?style=flat&colorA=000000&colorB=000000" alt="Version"></a>
<a href="https://github.com/adjsky/resulto/commits/master"><img src="https://img.shields.io/maintenance/yes/2023?style=flat&colorA=000000&colorB=000000" alt="Maintained"></a>
<a href="https://github.com/adjsky/resulto/commits/master"><img src="https://img.shields.io/maintenance/yes/2024?style=flat&colorA=000000&colorB=000000" alt="Maintained"></a>
<a href="https://github.com/adjsky/resulto/issues"><img src="https://img.shields.io/github/issues/adjsky/resulto?style=flat&colorA=000000&colorB=000000" alt="Issues"></a></p>
<p>TypeScript implementation of the <code>Result</code> type from <code>Rust</code> with a full-fledged
interface to work with async primitives.</p>
Expand Down
Loading

0 comments on commit 81a58a7

Please sign in to comment.