[go: up one dir, main page]
Skip to content

Commit

Permalink
update typedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@woodser
woodser committed May 27, 2024
1 parent 123f544 commit dbd6b0e
Show file tree
Hide file tree
Showing 21 changed files with 813 additions and 378 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

158 changes: 79 additions & 79 deletions docs/classes/HavenoClient.HavenoClient.html
View file

Large diffs are not rendered by default.

387 changes: 186 additions & 201 deletions docs/classes/protobuf_pb_pb.InitTradeRequest-1.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/classes/types_HavenoError.HavenoError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">HavenoError</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/types/HavenoError.ts#L21">src/types/HavenoError.ts:21</a></li></ul></aside>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/types/HavenoError.ts#L21">src/types/HavenoError.ts:21</a></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 @@ -71,7 +71,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> code: <span class="tsd
<h4 class="tsd-returns-title">Returns <a href="types_HavenoError.HavenoError.html" class="tsd-signature-type" data-tsd-kind="Class">HavenoError</a></h4><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/types/HavenoError.ts#L31">src/types/HavenoError.ts:31</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/types/HavenoError.ts#L31">src/types/HavenoError.ts:31</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a>
Expand All @@ -84,7 +84,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<h3 class="tsd-anchor-link"><span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/types/HavenoError.ts#L23">src/types/HavenoError.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/types/HavenoError.ts#L23">src/types/HavenoError.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand Down
46 changes: 23 additions & 23 deletions docs/classes/utils_HavenoUtils.HavenoUtils.html
View file

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions docs/classes/utils_TaskLooper.TaskLooper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">TaskLooper</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L21">src/utils/TaskLooper.ts:21</a></li></ul></aside>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L21">src/utils/TaskLooper.ts:21</a></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 @@ -71,7 +71,7 @@ <h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-sy
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="utils_TaskLooper.TaskLooper.html" class="tsd-signature-type" data-tsd-kind="Class">TaskLooper</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L33">src/utils/TaskLooper.ts:33</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L33">src/utils/TaskLooper.ts:33</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_fn" class="tsd-anchor"></a>
Expand All @@ -86,22 +86,22 @@ <h4>Type declaration</h4>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L23">src/utils/TaskLooper.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L23">src/utils/TaskLooper.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_isLooping" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>_is<wbr/>Looping</span><a href="#_isLooping" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">_is<wbr/>Looping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L25">src/utils/TaskLooper.ts:25</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L25">src/utils/TaskLooper.ts:25</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_isStarted" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>_is<wbr/>Started</span><a href="#_isStarted" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">_is<wbr/>Started<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L24">src/utils/TaskLooper.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L24">src/utils/TaskLooper.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_timeout" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>_timeout</span><a href="#_timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">_timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/utils_TaskLooper._internal_.Timeout.html" class="tsd-signature-type" data-tsd-kind="Interface">Timeout</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L26">src/utils/TaskLooper.ts:26</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L26">src/utils/TaskLooper.ts:26</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="_runLoop" class="tsd-anchor"></a>
Expand All @@ -118,7 +118,7 @@ <h5>periodInMs: <span class="tsd-signature-type">number</span></h5></li>
<h5>targetFixedPeriod: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L63">src/utils/TaskLooper.ts:63</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L63">src/utils/TaskLooper.ts:63</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="start" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -141,7 +141,7 @@ <h5>targetFixedPeriod: <span class="tsd-signature-type">boolean</span></h5>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L46">src/utils/TaskLooper.ts:46</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L46">src/utils/TaskLooper.ts:46</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stop" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>stop</span><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -151,7 +151,7 @@ <h3 class="tsd-anchor-link"><span>stop</span><a href="#stop" aria-label="Permali
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/4419822c/src/utils/TaskLooper.ts#L56">src/utils/TaskLooper.ts:56</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9fedfd40/src/utils/TaskLooper.ts#L56">src/utils/TaskLooper.ts:56</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit dbd6b0e

Please sign in to comment.