Git-Mirrors/haveno-ts
1
0
Fork 0
mirror of https://github.com/haveno-dex/haveno-ts.git synced 2025-05-08 17:45:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

update typedocs

Browse source
This commit is contained in:
woodser 2024-05-17 07:00:13 -04:00
parent e5a6d90e1d
commit 2d02b8ec96
1149 changed files with 9637 additions and 9568 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/classes/utils_TaskLooper.TaskLooper.html
View file

@ -24,7 +24,7 @@
<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/d4b7ab75/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/4419822c/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">
@ -71,7 +71,7 @@
<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/d4b7ab75/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/4419822c/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>
@ -86,43 +86,47 @@
<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/d4b7ab75/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/4419822c/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/d4b7ab75/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/4419822c/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/d4b7ab75/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/4419822c/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/d4b7ab75/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/4419822c/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>
<h3 class="tsd-anchor-link"><span>_run<wbr/>Loop</span><a href="#_runLoop" 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">
<li class="tsd-signature tsd-anchor-link" id="_runLoop._runLoop-1">_run<wbr/>Loop<span class="tsd-signature-symbol">(</span>periodInMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_runLoop._runLoop-1" 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></li>
<li class="tsd-signature tsd-anchor-link" id="_runLoop._runLoop-1">_run<wbr/>Loop<span class="tsd-signature-symbol">(</span>periodInMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, targetFixedPeriod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_runLoop._runLoop-1" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>periodInMs: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h5>periodInMs: <span class="tsd-signature-type">number</span></h5></li>
<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/d4b7ab75/src/utils/TaskLooper.ts#L61">src/utils/TaskLooper.ts:61</a></li></ul></aside></li></ul></section>
<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>
<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">
<li class="tsd-signature tsd-anchor-link" id="start.start-1">start<span class="tsd-signature-symbol">(</span>periodInMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#start.start-1" 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></li>
<li class="tsd-signature tsd-anchor-link" id="start.start-1">start<span class="tsd-signature-symbol">(</span>periodInMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, targetFixedPeriod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#start.start-1" 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></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Start the task loop.</p>
<h3>Returns</h3><p>this instance for chaining</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@ -130,10 +134,14 @@
<li>
<h5>periodInMs: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>the loop period in milliseconds</p>
</div></li>
<li>
<h5>targetFixedPeriod: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography"><p>specifies if the task should target a fixed period by accounting for run time (default false)</p>
</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/d4b7ab75/src/utils/TaskLooper.ts#L44">src/utils/TaskLooper.ts:44</a></li></ul></aside></li></ul></section>
<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>
<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">
@ -143,7 +151,7 @@
</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/d4b7ab75/src/utils/TaskLooper.ts#L54">src/utils/TaskLooper.ts:54</a></li></ul></aside></li></ul></section></section></div>
<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>
<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">
@ -317,12 +325,12 @@
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.SetConnectionRequest.html">Set<wbr/>Connection<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.SetWalletPasswordReply.html">Set<wbr/>Wallet<wbr/>Password<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.SetWalletPasswordRequest.html">Set<wbr/>Wallet<wbr/>Password<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StartCheckingConnectionsReply.html">Start<wbr/>Checking<wbr/>Connections<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StartCheckingConnectionsRequest.html">Start<wbr/>Checking<wbr/>Connections<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StartCheckingConnectionReply.html">Start<wbr/>Checking<wbr/>Connection<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StartCheckingConnectionRequest.html">Start<wbr/>Checking<wbr/>Connection<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StartXmrNodeReply.html">Start<wbr/>Xmr<wbr/>Node<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StartXmrNodeRequest.html">Start<wbr/>Xmr<wbr/>Node<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopCheckingConnectionsReply.html">Stop<wbr/>Checking<wbr/>Connections<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopCheckingConnectionsRequest.html">Stop<wbr/>Checking<wbr/>Connections<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopCheckingConnectionReply.html">Stop<wbr/>Checking<wbr/>Connection<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopCheckingConnectionRequest.html">Stop<wbr/>Checking<wbr/>Connection<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopReply.html">Stop<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopRequest.html">Stop<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopXmrNodeReply.html">Stop<wbr/>Xmr<wbr/>Node<wbr/>Reply</a></li>