ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release xrpl.js 2.11.0 (#2591)

Browse Source 
Update HISTORY.md + Run docgen
This commit is contained in:
Jackson Mills
2023-11-30 13:27:12 -08:00
committed by GitHub
parent 98abafbf12
commit 99dd0eb44c
341 changed files with 6499 additions and 2655 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/interfaces/LedgerEntry.DirectoryNode.html
View File

@@ -35,7 +35,7 @@ the ledger&#39;s state tree.</p>
<ul class="tsd-hierarchy">
<li><span class="target">DirectoryNode</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L9">packages/xrpl/src/models/ledger/DirectoryNode.ts:9</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L9">packages/xrpl/src/models/ledger/DirectoryNode.ts:9</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">
@@ -68,7 +68,7 @@ protocol defines no flags for DirectoryNode objects.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L17">packages/xrpl/src/models/ledger/DirectoryNode.ts:17</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L17">packages/xrpl/src/models/ledger/DirectoryNode.ts:17</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="IndexNext" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Index<wbr/>Next</span><a href="#IndexNext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Index<wbr/>Next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -77,7 +77,7 @@ object in the chain, wrapping around at the end.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L26">packages/xrpl/src/models/ledger/DirectoryNode.ts:26</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L26">packages/xrpl/src/models/ledger/DirectoryNode.ts:26</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="IndexPrevious" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Index<wbr/>Previous</span><a href="#IndexPrevious" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Index<wbr/>Previous</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -86,7 +86,7 @@ previous object in the chain, wrapping around at the beginning.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L31">packages/xrpl/src/models/ledger/DirectoryNode.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L31">packages/xrpl/src/models/ledger/DirectoryNode.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="Indexes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Indexes</span><a href="#Indexes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Indexes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
@@ -94,12 +94,12 @@ previous object in the chain, wrapping around at the beginning.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L21">packages/xrpl/src/models/ledger/DirectoryNode.ts:21</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L21">packages/xrpl/src/models/ledger/DirectoryNode.ts:21</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Ledger<wbr/>Entry<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;DirectoryNode&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L12">packages/xrpl/src/models/ledger/DirectoryNode.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L12">packages/xrpl/src/models/ledger/DirectoryNode.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="Owner" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Owner</span><a href="#Owner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Owner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -107,7 +107,7 @@ previous object in the chain, wrapping around at the beginning.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L33">packages/xrpl/src/models/ledger/DirectoryNode.ts:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L33">packages/xrpl/src/models/ledger/DirectoryNode.ts:33</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="PreviousTxnID" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Previous<wbr/>TxnID</span><a href="#PreviousTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Previous<wbr/>TxnID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span></div>
@@ -116,7 +116,7 @@ previous object in the chain, wrapping around at the beginning.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from MissingPreviousTxnID.PreviousTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L22">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:22</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L22">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:22</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="PreviousTxnLgrSeq" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</span><a href="#PreviousTxnLgrSeq" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span></div>
@@ -125,7 +125,7 @@ previous object in the chain, wrapping around at the beginning.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from MissingPreviousTxnID.PreviousTxnLgrSeq</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L26">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:26</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L26">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:26</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="RootIndex" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Root<wbr/>Index</span><a href="#RootIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Root<wbr/>Index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -133,7 +133,7 @@ previous object in the chain, wrapping around at the beginning.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L19">packages/xrpl/src/models/ledger/DirectoryNode.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L19">packages/xrpl/src/models/ledger/DirectoryNode.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="TakerGetsCurrency" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Taker<wbr/>Gets<wbr/>Currency</span><a href="#TakerGetsCurrency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Taker<wbr/>Gets<wbr/>Currency</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -142,7 +142,7 @@ directory.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L45">packages/xrpl/src/models/ledger/DirectoryNode.ts:45</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L45">packages/xrpl/src/models/ledger/DirectoryNode.ts:45</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="TakerGetsIssuer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Taker<wbr/>Gets<wbr/>Issuer</span><a href="#TakerGetsIssuer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Taker<wbr/>Gets<wbr/>Issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -150,7 +150,7 @@ directory.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L47">packages/xrpl/src/models/ledger/DirectoryNode.ts:47</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L47">packages/xrpl/src/models/ledger/DirectoryNode.ts:47</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="TakerPaysCurrency" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Taker<wbr/>Pays<wbr/>Currency</span><a href="#TakerPaysCurrency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Taker<wbr/>Pays<wbr/>Currency</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -159,7 +159,7 @@ directory.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L38">packages/xrpl/src/models/ledger/DirectoryNode.ts:38</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L38">packages/xrpl/src/models/ledger/DirectoryNode.ts:38</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="TakerPaysIssuer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Taker<wbr/>Pays<wbr/>Issuer</span><a href="#TakerPaysIssuer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Taker<wbr/>Pays<wbr/>Issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -167,13 +167,13 @@ directory.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/ledger/DirectoryNode.ts#L40">packages/xrpl/src/models/ledger/DirectoryNode.ts:40</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/ledger/DirectoryNode.ts#L40">packages/xrpl/src/models/ledger/DirectoryNode.ts:40</a></li></ul></aside></section>
<section class="tsd-panel tsd-member 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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">index</span><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/8b781479/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/98abafbf1/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-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -224,6 +224,7 @@ directory.</p>
<li><a href="LedgerEntry.Amendments.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Amendments</span></a></li>
<li><a href="LedgerEntry.Bridge.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Bridge</span></a></li>
<li><a href="LedgerEntry.Check.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Check</span></a></li>
<li><a href="LedgerEntry.DID.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>DID</span></a></li>
<li><a href="LedgerEntry.DepositPreauth.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deposit<wbr/>Preauth</span></a></li>
<li><a href="LedgerEntry.DirectoryNode.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Directory<wbr/>Node</span></a></li>
<li><a href="LedgerEntry.Escrow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Escrow</span></a></li>
@@ -333,6 +334,8 @@ directory.</p>
<li><a href="ClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Client<wbr/>Options</span></a></li>
<li><a href="ConsensusStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Consensus<wbr/>Stream</span></a></li>
<li><a href="CreatedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Created<wbr/>Node</span></a></li>
<li><a href="DIDDelete.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>DIDDelete</span></a></li>
<li><a href="DIDSet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>DIDSet</span></a></li>
<li><a href="DeletedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deleted<wbr/>Node</span></a></li>
<li><a href="DepositAuthorizedRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deposit<wbr/>Authorized<wbr/>Request</span></a></li>
<li><a href="DepositAuthorizedResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deposit<wbr/>Authorized<wbr/>Response</span></a></li>
@@ -417,6 +420,8 @@ directory.</p>
<li><a href="RipplePathFindPathOption.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Path<wbr/>Option</span></a></li>
<li><a href="RipplePathFindRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Request</span></a></li>
<li><a href="RipplePathFindResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Response</span></a></li>
<li><a href="ServerDefinitionsRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Definitions<wbr/>Request</span></a></li>
<li><a href="ServerDefinitionsResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Definitions<wbr/>Response</span></a></li>
<li><a href="ServerInfoRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Info<wbr/>Request</span></a></li>
<li><a href="ServerInfoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Info<wbr/>Response</span></a></li>
<li><a href="ServerStateRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>State<wbr/>Request</span></a></li>