Release xrpl.js 2.7.0 (#2240)

This commit is contained in:
Jackson Mills
2023-03-08 15:05:00 -08:00
committed by GitHub
parent 4ec8c99056
commit b3d3bc2f99
234 changed files with 2214 additions and 1767 deletions

View File

@@ -33,7 +33,7 @@ form of an <a href="UnsubscribeResponse.html">UnsubscribeResponse</a>.</p>
<ul class="tsd-hierarchy">
<li><span class="target">UnsubscribeRequest</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/unsubscribe.ts#L18">packages/xrpl/src/models/methods/unsubscribe.ts:18</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/unsubscribe.ts#L18">packages/xrpl/src/models/methods/unsubscribe.ts:18</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">
@@ -58,7 +58,7 @@ form of an <a href="UnsubscribeResponse.html">UnsubscribeResponse</a>.</p>
XRP Ledger&#39;s base58 format.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/unsubscribe.ts#L29">packages/xrpl/src/models/methods/unsubscribe.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/unsubscribe.ts#L29">packages/xrpl/src/models/methods/unsubscribe.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="accounts_proposed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>accounts_<wbr/>proposed</span><a href="#accounts_proposed" 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">accounts_<wbr/>proposed<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
@@ -66,7 +66,7 @@ XRP Ledger&#39;s base58 format.</p>
not-yet-validated transactions.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/unsubscribe.ts#L34">packages/xrpl/src/models/methods/unsubscribe.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/unsubscribe.ts#L34">packages/xrpl/src/models/methods/unsubscribe.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api_<wbr/>version</span><a href="#api_version" 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">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -74,7 +74,7 @@ not-yet-validated transactions.</p>
</div><aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="books" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>books</span><a href="#books" 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">books<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Book</span><span class="tsd-signature-symbol">[]</span></div>
@@ -82,13 +82,13 @@ not-yet-validated transactions.</p>
below.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/unsubscribe.ts#L39">packages/xrpl/src/models/methods/unsubscribe.ts:39</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/unsubscribe.ts#L39">packages/xrpl/src/models/methods/unsubscribe.ts:39</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="command" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>command</span><a href="#command" 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">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;unsubscribe&quot;</span></div><aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/unsubscribe.ts#L19">packages/xrpl/src/models/methods/unsubscribe.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/unsubscribe.ts#L19">packages/xrpl/src/models/methods/unsubscribe.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>id</span><a href="#id" 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">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
@@ -98,7 +98,7 @@ know which request prompted which response.</p>
</div><aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="streams" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>streams</span><a href="#streams" 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">streams<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StreamType</span><span class="tsd-signature-symbol">[]</span></div>
@@ -106,7 +106,7 @@ know which request prompted which response.</p>
Ledger, server, transactions, and transactions_proposed.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/unsubscribe.ts#L24">packages/xrpl/src/models/methods/unsubscribe.ts:24</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/unsubscribe.ts#L24">packages/xrpl/src/models/methods/unsubscribe.ts:24</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">