ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-15 10:05:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Make the docs more robust with examples (#2226)

Browse Source 
* doc: Make the docs more robust with examples
This commit is contained in:
justinr1234
2023-05-02 13:53:17 -07:00
committed by GitHub
parent 9131ab2515
commit 81f2233507
233 changed files with 8396 additions and 5109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/interfaces/TrustSetFlagsInterface.html
View File

@@ -25,7 +25,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<div class="tsd-comment tsd-typography"><p>Map of flags to boolean values representing <a href="TrustSet.html">TrustSet</a> transaction
flags.</p>
<h3>Example</h3><pre><code class="language-typescript"><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">trustSetTx</span><span class="hl-1">: </span><span class="hl-7">TrustSet</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">&#39;TrustSet&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-0">wallet2</span><span class="hl-1">.</span><span class="hl-4">getClassicAddress</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-0">LimitAmount:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">currency:</span><span class="hl-1"> </span><span class="hl-5">&#39;FOO&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">issuer:</span><span class="hl-1"> </span><span class="hl-0">wallet1</span><span class="hl-1">.</span><span class="hl-4">getClassicAddress</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-0">value:</span><span class="hl-1"> </span><span class="hl-5">&#39;10000000000&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">Flags:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">tfSetNoRipple:</span><span class="hl-1"> </span><span class="hl-2">true</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-8">// Autofill the tx to see how flags actually look compared to the interface usage.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">autofilledTx</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">autofill</span><span class="hl-1">(</span><span class="hl-0">trustSetTx</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">autofilledTx</span><span class="hl-1">)</span><br/><span class="hl-8">// {</span><br/><span class="hl-8">// TransactionType: &#39;TrustSet&#39;,</span><br/><span class="hl-8">// Account: &#39;r9dAdQQCBcGajVSeC9CqW3LCugjPDnAkEb&#39;,</span><br/><span class="hl-8">// LimitAmount: {</span><br/><span class="hl-8">// currency: &#39;FOO&#39;,</span><br/><span class="hl-8">// issuer: &#39;rWZzUjo5xGiAoRBqzsndyzonXz47UV8u1&#39;,</span><br/><span class="hl-8">// value: &#39;10000000000&#39;</span><br/><span class="hl-8">// },</span><br/><span class="hl-8">// Flags: 131072,</span><br/><span class="hl-8">// Sequence: 21971483,</span><br/><span class="hl-8">// Fee: &#39;12&#39;,</span><br/><span class="hl-8">// LastLedgerSequence: 21971503</span><br/><span class="hl-8">// }</span>
<h3>Example</h3><pre><code class="language-typescript"><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">trustSetTx</span><span class="hl-1">: </span><span class="hl-8">TrustSet</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">&#39;TrustSet&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-0">wallet2</span><span class="hl-1">.</span><span class="hl-4">getClassicAddress</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-0">LimitAmount:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">currency:</span><span class="hl-1"> </span><span class="hl-5">&#39;FOO&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">issuer:</span><span class="hl-1"> </span><span class="hl-0">wallet1</span><span class="hl-1">.</span><span class="hl-4">getClassicAddress</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-0">value:</span><span class="hl-1"> </span><span class="hl-5">&#39;10000000000&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">Flags:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">tfSetNoRipple:</span><span class="hl-1"> </span><span class="hl-2">true</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-7">// Autofill the tx to see how flags actually look compared to the interface usage.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">autofilledTx</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">autofill</span><span class="hl-1">(</span><span class="hl-0">trustSetTx</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">autofilledTx</span><span class="hl-1">)</span><br/><span class="hl-7">// {</span><br/><span class="hl-7">// TransactionType: &#39;TrustSet&#39;,</span><br/><span class="hl-7">// Account: &#39;r9dAdQQCBcGajVSeC9CqW3LCugjPDnAkEb&#39;,</span><br/><span class="hl-7">// LimitAmount: {</span><br/><span class="hl-7">// currency: &#39;FOO&#39;,</span><br/><span class="hl-7">// issuer: &#39;rWZzUjo5xGiAoRBqzsndyzonXz47UV8u1&#39;,</span><br/><span class="hl-7">// value: &#39;10000000000&#39;</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// Flags: 131072,</span><br/><span class="hl-7">// Sequence: 21971483,</span><br/><span class="hl-7">// Fee: &#39;12&#39;,</span><br/><span class="hl-7">// LastLedgerSequence: 21971503</span><br/><span class="hl-7">// }</span>
</code></pre>
</div></section>
<section class="tsd-panel tsd-hierarchy">
@@ -35,7 +35,7 @@ flags.</p>
<ul class="tsd-hierarchy">
<li><span class="target">TrustSetFlagsInterface</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/transactions/trustSet.ts#L75">packages/xrpl/src/models/transactions/trustSet.ts:75</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/transactions/trustSet.ts#L75">packages/xrpl/src/models/transactions/trustSet.ts:75</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">
@@ -57,21 +57,21 @@ flags.</p>
<div class="tsd-comment tsd-typography"><p>Unfreeze the trust line.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/transactions/trustSet.ts#L91">packages/xrpl/src/models/transactions/trustSet.ts:91</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/transactions/trustSet.ts#L91">packages/xrpl/src/models/transactions/trustSet.ts:91</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfClearNoRipple" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>Clear<wbr/>No<wbr/>Ripple</span><a href="#tfClearNoRipple" 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">tf<wbr/>Clear<wbr/>No<wbr/>Ripple<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>Disable the No Ripple flag, allowing rippling on this trust line.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/transactions/trustSet.ts#L87">packages/xrpl/src/models/transactions/trustSet.ts:87</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/transactions/trustSet.ts#L87">packages/xrpl/src/models/transactions/trustSet.ts:87</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfSetFreeze" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>Set<wbr/>Freeze</span><a href="#tfSetFreeze" 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">tf<wbr/>Set<wbr/>Freeze<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>Freeze the trust line.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/transactions/trustSet.ts#L89">packages/xrpl/src/models/transactions/trustSet.ts:89</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/transactions/trustSet.ts#L89">packages/xrpl/src/models/transactions/trustSet.ts:89</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfSetNoRipple" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>Set<wbr/>No<wbr/>Ripple</span><a href="#tfSetNoRipple" 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">tf<wbr/>Set<wbr/>No<wbr/>Ripple<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -79,7 +79,7 @@ flags.</p>
of the same currency if this flag is enabled on both.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/transactions/trustSet.ts#L85">packages/xrpl/src/models/transactions/trustSet.ts:85</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/transactions/trustSet.ts#L85">packages/xrpl/src/models/transactions/trustSet.ts:85</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfSetfAuth" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>Setf<wbr/>Auth</span><a href="#tfSetfAuth" 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">tf<wbr/>Setf<wbr/>Auth<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -87,7 +87,7 @@ of the same currency if this flag is enabled on both.</p>
effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/transactions/trustSet.ts#L80">packages/xrpl/src/models/transactions/trustSet.ts:80</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/transactions/trustSet.ts#L80">packages/xrpl/src/models/transactions/trustSet.ts:80</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">