update reference docs and add readme to homepage (#2112)

This commit is contained in:
jonathanlei
2022-10-13 09:21:28 -07:00
committed by GitHub
parent 9df848fcc6
commit 1ceae703db
214 changed files with 3761 additions and 3651 deletions

View File

@@ -25,7 +25,7 @@ server is in.</p>
<ul class="tsd-hierarchy">
<li><span class="target">ConsensusStream</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/methods/subscribe.ts#L366">packages/xrpl/src/models/methods/subscribe.ts:366</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L366">packages/xrpl/src/models/methods/subscribe.ts:366</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">
@@ -45,13 +45,13 @@ server is in.</p>
establish, and accepted.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/methods/subscribe.ts#L372">packages/xrpl/src/models/methods/subscribe.ts:372</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L372">packages/xrpl/src/models/methods/subscribe.ts:372</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;consensusPhase&quot;</span></div><aside class="tsd-sources">
<p>Overrides BaseStream.type</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/methods/subscribe.ts#L367">packages/xrpl/src/models/methods/subscribe.ts:367</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L367">packages/xrpl/src/models/methods/subscribe.ts:367</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">