update api typedocs

This commit is contained in:
woodser 2024-02-02 09:05:22 -05:00
parent c9692a7a08
commit a7dc0fa89c
1150 changed files with 16892 additions and 16609 deletions

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/woodser/haveno-ts/blob/9b8362c5/src/utils/TaskLooper.ts#L4">src/utils/TaskLooper.ts:4</a></li></ul></aside>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/5b8cb76a/src/utils/TaskLooper.ts#L4">src/utils/TaskLooper.ts:4</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/woodser/haveno-ts/blob/9b8362c5/src/utils/TaskLooper.ts#L16">src/utils/TaskLooper.ts:16</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/5b8cb76a/src/utils/TaskLooper.ts#L16">src/utils/TaskLooper.ts:16</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,22 +86,22 @@
<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/woodser/haveno-ts/blob/9b8362c5/src/utils/TaskLooper.ts#L6">src/utils/TaskLooper.ts:6</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/5b8cb76a/src/utils/TaskLooper.ts#L6">src/utils/TaskLooper.ts:6</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/woodser/haveno-ts/blob/9b8362c5/src/utils/TaskLooper.ts#L8">src/utils/TaskLooper.ts:8</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/5b8cb76a/src/utils/TaskLooper.ts#L8">src/utils/TaskLooper.ts:8</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/woodser/haveno-ts/blob/9b8362c5/src/utils/TaskLooper.ts#L7">src/utils/TaskLooper.ts:7</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/5b8cb76a/src/utils/TaskLooper.ts#L7">src/utils/TaskLooper.ts:7</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/woodser/haveno-ts/blob/9b8362c5/src/utils/TaskLooper.ts#L9">src/utils/TaskLooper.ts:9</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/5b8cb76a/src/utils/TaskLooper.ts#L9">src/utils/TaskLooper.ts:9</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>
@ -116,7 +116,7 @@
<h5>periodInMs: <span class="tsd-signature-type">number</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/woodser/haveno-ts/blob/9b8362c5/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/5b8cb76a/src/utils/TaskLooper.ts#L44">src/utils/TaskLooper.ts:44</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">
@ -133,7 +133,7 @@
</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/woodser/haveno-ts/blob/9b8362c5/src/utils/TaskLooper.ts#L27">src/utils/TaskLooper.ts:27</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/5b8cb76a/src/utils/TaskLooper.ts#L27">src/utils/TaskLooper.ts:27</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 +143,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/woodser/haveno-ts/blob/9b8362c5/src/utils/TaskLooper.ts#L37">src/utils/TaskLooper.ts:37</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/5b8cb76a/src/utils/TaskLooper.ts#L37">src/utils/TaskLooper.ts:37</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">
@ -233,8 +233,6 @@
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetFundingAddressesRequest.html">Get<wbr/>Funding<wbr/>Addresses<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetMethodHelpReply.html">Get<wbr/>Method<wbr/>Help<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetMethodHelpRequest.html">Get<wbr/>Method<wbr/>Help<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetMoneroNodeSettingsReply.html">Get<wbr/>Monero<wbr/>Node<wbr/>Settings<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetMoneroNodeSettingsRequest.html">Get<wbr/>Monero<wbr/>Node<wbr/>Settings<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetMyOfferReply.html">Get<wbr/>My<wbr/>Offer<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetMyOfferRequest.html">Get<wbr/>My<wbr/>Offer<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetMyOffersReply.html">Get<wbr/>My<wbr/>Offers<wbr/>Reply</a></li>
@ -261,6 +259,8 @@
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetVersionRequest.html">Get<wbr/>Version<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetXmrNewSubaddressReply.html">Get<wbr/>Xmr<wbr/>New<wbr/>Subaddress<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetXmrNewSubaddressRequest.html">Get<wbr/>Xmr<wbr/>New<wbr/>Subaddress<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetXmrNodeSettingsReply.html">Get<wbr/>Xmr<wbr/>Node<wbr/>Settings<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetXmrNodeSettingsRequest.html">Get<wbr/>Xmr<wbr/>Node<wbr/>Settings<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetXmrPrimaryAddressReply.html">Get<wbr/>Xmr<wbr/>Primary<wbr/>Address<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetXmrPrimaryAddressRequest.html">Get<wbr/>Xmr<wbr/>Primary<wbr/>Address<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.GetXmrSeedReply.html">Get<wbr/>Xmr<wbr/>Seed<wbr/>Reply</a></li>
@ -271,8 +271,8 @@
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.IsAccountOpenRequest.html">Is<wbr/>Account<wbr/>Open<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.IsAppInitializedReply.html">Is<wbr/>App<wbr/>Initialized<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.IsAppInitializedRequest.html">Is<wbr/>App<wbr/>Initialized<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.IsMoneroNodeOnlineReply.html">Is<wbr/>Monero<wbr/>Node<wbr/>Online<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.IsMoneroNodeOnlineRequest.html">Is<wbr/>Monero<wbr/>Node<wbr/>Online<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.IsXmrNodeOnlineReply.html">Is<wbr/>Xmr<wbr/>Node<wbr/>Online<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.IsXmrNodeOnlineRequest.html">Is<wbr/>Xmr<wbr/>Node<wbr/>Online<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.LockWalletReply.html">Lock<wbr/>Wallet<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.LockWalletRequest.html">Lock<wbr/>Wallet<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.MarketDepthInfo.html">Market<wbr/>Depth<wbr/>Info</a></li>
@ -319,14 +319,14 @@
<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.StartMoneroNodeReply.html">Start<wbr/>Monero<wbr/>Node<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StartMoneroNodeRequest.html">Start<wbr/>Monero<wbr/>Node<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.StopMoneroNodeReply.html">Stop<wbr/>Monero<wbr/>Node<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopMoneroNodeRequest.html">Stop<wbr/>Monero<wbr/>Node<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>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.StopXmrNodeRequest.html">Stop<wbr/>Xmr<wbr/>Node<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.TakeOfferReply.html">Take<wbr/>Offer<wbr/>Reply</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.TakeOfferRequest.html">Take<wbr/>Offer<wbr/>Request</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_grpc_pb.TradeInfo.html">Trade<wbr/>Info</a></li>
@ -427,7 +427,6 @@
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.Mediator.html">Mediator</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.MockMailboxPayload.html">Mock<wbr/>Mailbox<wbr/>Payload</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.MockPayload.html">Mock<wbr/>Payload</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.MoneroNodeSettings.html">Monero<wbr/>Node<wbr/>Settings</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.MoneseAccountPayload.html">Monese<wbr/>Account<wbr/>Payload</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.MoneyBeamAccountPayload.html">Money<wbr/>Beam<wbr/>Account<wbr/>Payload</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.MoneyGramAccountPayload.html">Money<wbr/>Gram<wbr/>Account<wbr/>Payload</a></li>
@ -530,9 +529,10 @@
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.WesternUnionAccountPayload.html">Western<wbr/>Union<wbr/>Account<wbr/>Payload</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.XmrAddressEntry.html">Xmr<wbr/>Address<wbr/>Entry</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.XmrAddressEntryList.html">Xmr<wbr/>Address<wbr/>Entry<wbr/>List</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.XmrNodeSettings.html">Xmr<wbr/>Node<wbr/>Settings</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/protobuf_pb_pb.ZelleAccountPayload.html">Zelle<wbr/>Account<wbr/>Payload</a></li></ul></li>
<li class="tsd-kind-module"><a href="../modules/protobuf_pb_pb-1.html">protobuf/pb_<wbr/>pb</a></li>
<li class="tsd-kind-module"><a href="../modules/utils_HavenoError.html">utils/<wbr/>Haveno<wbr/>Error</a></li>
<li class="tsd-kind-module"><a href="../modules/types_HavenoError.html">types/<wbr/>Haveno<wbr/>Error</a></li>
<li class="tsd-kind-module"><a href="../modules/utils_HavenoUtils.html">utils/<wbr/>Haveno<wbr/>Utils</a></li>
<li class="current tsd-kind-module"><a href="../modules/utils_TaskLooper.html">utils/<wbr/>Task<wbr/>Looper</a>
<ul>