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

* 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

View File

@@ -34,7 +34,7 @@ a previous ledger version.</p>
<ul class="tsd-hierarchy">
<li><span class="target">LedgerHashes</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/ledger/LedgerHashes.ts#L10">packages/xrpl/src/models/ledger/LedgerHashes.ts:10</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/ledger/LedgerHashes.ts#L10">packages/xrpl/src/models/ledger/LedgerHashes.ts:10</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,7 +57,7 @@ a previous ledger version.</p>
type.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/ledger/LedgerHashes.ts#L23">packages/xrpl/src/models/ledger/LedgerHashes.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/ledger/LedgerHashes.ts#L23">packages/xrpl/src/models/ledger/LedgerHashes.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Hashes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Hashes</span><a href="#Hashes" 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">Hashes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
@@ -65,25 +65,25 @@ type.</p>
of LedgerHashes object this is.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/ledger/LedgerHashes.ts#L18">packages/xrpl/src/models/ledger/LedgerHashes.ts:18</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/ledger/LedgerHashes.ts#L18">packages/xrpl/src/models/ledger/LedgerHashes.ts:18</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="LastLedgerSequence" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Last<wbr/>Ledger<wbr/>Sequence</span><a href="#LastLedgerSequence" 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">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The Ledger Index of the last entry in this object&#39;s Hashes array.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/ledger/LedgerHashes.ts#L13">packages/xrpl/src/models/ledger/LedgerHashes.ts:13</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/ledger/LedgerHashes.ts#L13">packages/xrpl/src/models/ledger/LedgerHashes.ts:13</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="LedgerEntryType" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Ledger<wbr/>Entry<wbr/>Type</span><a href="#LedgerEntryType" 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">Ledger<wbr/>Entry<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;LedgerHashes&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/ledger/LedgerHashes.ts#L11">packages/xrpl/src/models/ledger/LedgerHashes.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/ledger/LedgerHashes.ts#L11">packages/xrpl/src/models/ledger/LedgerHashes.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="index" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>index</span><a href="#index" 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">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from BaseLedgerEntry.index</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L2">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L2">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2</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">