Git-Mirrors/haveno-ts
1
0
Fork 0
mirror of https://github.com/haveno-dex/haveno-ts.git synced 2025-07-22 14:30:51 -04:00
Code Issues Projects Releases Packages Wiki Activity

update typedocs

Browse source
This commit is contained in:
woodser 2025-06-08 16:32:00 -04:00
parent 417103a702
commit 5f29a712d1
No known key found for this signature in database
GPG key ID: 55A10DD48ADEE5EF
11 changed files with 138 additions and 138 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/interfaces/HavenoClient.OfferConfig.html
View file

@ -24,7 +24,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">OfferConfig</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9e8122f6/src/HavenoClient.ts#L31">src/HavenoClient.ts:31</a></li></ul></aside>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L31">src/HavenoClient.ts:31</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">
@ -53,72 +53,72 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>amount</span><a href="#amount" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
<div class="tsd-signature">amount<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">bigint</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9e8122f6/src/HavenoClient.ts#L33">src/HavenoClient.ts:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L33">src/HavenoClient.ts:33</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="assetCode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>asset<wbr/>Code</span><a href="#assetCode" 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">asset<wbr/>Code<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9e8122f6/src/HavenoClient.ts#L35">src/HavenoClient.ts:35</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L35">src/HavenoClient.ts:35</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="buyerAsTakerWithoutDeposit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>buyer<wbr/>As<wbr/>Taker<wbr/>Without<wbr/>Deposit</span><a href="#buyerAsTakerWithoutDeposit" 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">buyer<wbr/>As<wbr/>Taker<wbr/>Without<wbr/>Deposit<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/9e8122f6/src/HavenoClient.ts#L43">src/HavenoClient.ts:43</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L43">src/HavenoClient.ts:43</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="direction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>direction</span><a href="#direction" 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">direction<span class="tsd-signature-symbol">?:</span> <a href="../enums/protobuf_pb_pb.OfferDirection.html" class="tsd-signature-type" data-tsd-kind="Enumeration">OfferDirection</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9e8122f6/src/HavenoClient.ts#L32">src/HavenoClient.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L32">src/HavenoClient.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="extraInfo" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>extra<wbr/>Info</span><a href="#extraInfo" 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">extra<wbr/>Info<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9e8122f6/src/HavenoClient.ts#L44">src/HavenoClient.ts:44</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L44">src/HavenoClient.ts:44</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="isPrivateOffer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>is<wbr/>Private<wbr/>Offer</span><a href="#isPrivateOffer" 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/>Private<wbr/>Offer<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/9e8122f6/src/HavenoClient.ts#L42">src/HavenoClient.ts:42</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L42">src/HavenoClient.ts:42</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="marketPriceMarginPct" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>market<wbr/>Price<wbr/>Margin<wbr/>Pct</span><a href="#marketPriceMarginPct" 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">market<wbr/>Price<wbr/>Margin<wbr/>Pct<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/9e8122f6/src/HavenoClient.ts#L39">src/HavenoClient.ts:39</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L39">src/HavenoClient.ts:39</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="minAmount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>min<wbr/>Amount</span><a href="#minAmount" 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">min<wbr/>Amount<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">bigint</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9e8122f6/src/HavenoClient.ts#L34">src/HavenoClient.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L34">src/HavenoClient.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="paymentAccountId" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>payment<wbr/>Account<wbr/>Id</span><a href="#paymentAccountId" 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">payment<wbr/>Account<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9e8122f6/src/HavenoClient.ts#L36">src/HavenoClient.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L36">src/HavenoClient.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="price" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>price</span><a href="#price" 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">price<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/9e8122f6/src/HavenoClient.ts#L38">src/HavenoClient.ts:38</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L38">src/HavenoClient.ts:38</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reserveExactAmount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>reserve<wbr/>Exact<wbr/>Amount</span><a href="#reserveExactAmount" 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">reserve<wbr/>Exact<wbr/>Amount<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/9e8122f6/src/HavenoClient.ts#L41">src/HavenoClient.ts:41</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L41">src/HavenoClient.ts:41</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityDepositPct" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Deposit<wbr/>Pct</span><a href="#securityDepositPct" 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">security<wbr/>Deposit<wbr/>Pct<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/9e8122f6/src/HavenoClient.ts#L37">src/HavenoClient.ts:37</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L37">src/HavenoClient.ts:37</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sourceOfferId" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>source<wbr/>Offer<wbr/>Id</span><a href="#sourceOfferId" 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">source<wbr/>Offer<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/9e8122f6/src/HavenoClient.ts#L45">src/HavenoClient.ts:45</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L45">src/HavenoClient.ts:45</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="triggerPrice" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>trigger<wbr/>Price</span><a href="#triggerPrice" 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">trigger<wbr/>Price<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/9e8122f6/src/HavenoClient.ts#L40">src/HavenoClient.ts:40</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/haveno-dex/haveno-ts/blob/594d3dd3/src/HavenoClient.ts#L40">src/HavenoClient.ts:40</a></li></ul></aside></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">