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

fix: update reference docs (#1928)

Browse Source 
* npm run docgen

* fix: update docgen info in CONTRIBUTING.md
This commit is contained in:
Elliot Lee
2022-02-10 15:22:11 -08:00
committed by GitHub
parent 1e30b4cb43
commit 1258615a0c
163 changed files with 1278 additions and 1236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/interfaces/LedgerStream.html
View File

@@ -2,29 +2,29 @@
<p>The <code>ledger</code> stream only sends <code>ledgerClosed</code> messages when the consensus
process declares a new validated ledger. The message identifies the ledger
And provides some information about its contents.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseStream</span><ul class="tsd-hierarchy"><li><span class="target">LedgerStream</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_base" class="tsd-kind-icon">fee_<wbr/>base</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_ref" class="tsd-kind-icon">fee_<wbr/>ref</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_time" class="tsd-kind-icon">ledger_<wbr/>time</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr/>base</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr/>inc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#txn_count" class="tsd-kind-icon">txn_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#validated_ledgers" class="tsd-kind-icon">validated_<wbr/>ledgers</a></li></ul></section></div></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-interface"><a id="fee_base" class="tsd-anchor"></a><h3>fee_<wbr/>base</h3><div class="tsd-signature tsd-kind-icon">fee_<wbr/>base<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L98">packages/xrpl/src/models/methods/subscribe.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseStream</span><ul class="tsd-hierarchy"><li><span class="target">LedgerStream</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_base" class="tsd-kind-icon">fee_<wbr/>base</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_ref" class="tsd-kind-icon">fee_<wbr/>ref</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_time" class="tsd-kind-icon">ledger_<wbr/>time</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr/>base</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr/>inc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#txn_count" class="tsd-kind-icon">txn_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#validated_ledgers" class="tsd-kind-icon">validated_<wbr/>ledgers</a></li></ul></section></div></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-interface"><a id="fee_base" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fee_<wbr/>base<a href="#fee_base" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">fee_<wbr/>base<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L98">packages/xrpl/src/models/methods/subscribe.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The reference transaction cost as of this ledger version, in drops of XRP.
If this ledger version includes a SetFee pseudo-transaction the new.
Transaction cost applies starting with the following ledger version.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fee_ref" class="tsd-anchor"></a><h3>fee_<wbr/>ref</h3><div class="tsd-signature tsd-kind-icon">fee_<wbr/>ref<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L100">packages/xrpl/src/models/methods/subscribe.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fee_ref" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fee_<wbr/>ref<a href="#fee_ref" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">fee_<wbr/>ref<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L100">packages/xrpl/src/models/methods/subscribe.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The reference transaction cost in &quot;fee units&quot;.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3>ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L102">packages/xrpl/src/models/methods/subscribe.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L102">packages/xrpl/src/models/methods/subscribe.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The identifying hash of the ledger version that was closed.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3>ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L104">packages/xrpl/src/models/methods/subscribe.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L104">packages/xrpl/src/models/methods/subscribe.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ledger index of the ledger that was closed.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_time" class="tsd-anchor"></a><h3>ledger_<wbr/>time</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>time<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L106">packages/xrpl/src/models/methods/subscribe.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ledger_<wbr/>time<a href="#ledger_time" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>time<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L106">packages/xrpl/src/models/methods/subscribe.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The time this ledger was closed, in seconds since the Ripple Epoch.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reserve_base" class="tsd-anchor"></a><h3>reserve_<wbr/>base</h3><div class="tsd-signature tsd-kind-icon">reserve_<wbr/>base<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L112">packages/xrpl/src/models/methods/subscribe.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reserve_base" class="tsd-anchor"></a><h3 class="tsd-anchor-link">reserve_<wbr/>base<a href="#reserve_base" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">reserve_<wbr/>base<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L112">packages/xrpl/src/models/methods/subscribe.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The minimum reserve, in drops of XRP, that is required for an account. If
this ledger version includes a SetFee pseudo-transaction the new base reserve
applies starting with the following ledger version.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reserve_inc" class="tsd-anchor"></a><h3>reserve_<wbr/>inc</h3><div class="tsd-signature tsd-kind-icon">reserve_<wbr/>inc<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L118">packages/xrpl/src/models/methods/subscribe.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reserve_inc" class="tsd-anchor"></a><h3 class="tsd-anchor-link">reserve_<wbr/>inc<a href="#reserve_inc" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">reserve_<wbr/>inc<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L118">packages/xrpl/src/models/methods/subscribe.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The owner reserve for each object an account owns in the ledger, in drops
of XRP. If the ledger includes a SetFee pseudo-transaction the new owner
reserve applies after this ledger.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="txn_count" class="tsd-anchor"></a><h3>txn_<wbr/>count</h3><div class="tsd-signature tsd-kind-icon">txn_<wbr/>count<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L120">packages/xrpl/src/models/methods/subscribe.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="txn_count" class="tsd-anchor"></a><h3 class="tsd-anchor-link">txn_<wbr/>count<a href="#txn_count" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">txn_<wbr/>count<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L120">packages/xrpl/src/models/methods/subscribe.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Number of new transactions included in this ledger version.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ledgerClosed&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/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L92">packages/xrpl/src/models/methods/subscribe.ts:92</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="validated_ledgers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> validated_<wbr/>ledgers</h3><div class="tsd-signature tsd-kind-icon">validated_<wbr/>ledgers<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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L127">packages/xrpl/src/models/methods/subscribe.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link">type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ledgerClosed&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/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L92">packages/xrpl/src/models/methods/subscribe.ts:92</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="validated_ledgers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> validated_<wbr/>ledgers<a href="#validated_ledgers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">validated_<wbr/>ledgers<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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L127">packages/xrpl/src/models/methods/subscribe.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Range of ledgers that the server has available. This may be a disjoint
sequence such as 24900901-24900984,24901116-24901158. This field is not
returned if the server is not connected to the network, or if it is