Release xrpl.js 2.11.0 (#2591)

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

View File

@@ -28,7 +28,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<ul class="tsd-hierarchy">
<li><span class="target">AMMWithdrawFlagsInterface</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/transactions/AMMWithdraw.ts#L28">packages/xrpl/src/models/transactions/AMMWithdraw.ts:28</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L28">packages/xrpl/src/models/transactions/AMMWithdraw.ts:28</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">
@@ -50,37 +50,37 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tfLPToken</span><a href="#tfLPToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><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></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">tfLPToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L29">packages/xrpl/src/models/transactions/AMMWithdraw.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L29">packages/xrpl/src/models/transactions/AMMWithdraw.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="tfLimitLPToken" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>LimitLPToken</span><a href="#tfLimitLPToken" 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">tf<wbr/>LimitLPToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L35">packages/xrpl/src/models/transactions/AMMWithdraw.ts:35</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L35">packages/xrpl/src/models/transactions/AMMWithdraw.ts:35</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="tfOneAssetLPToken" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>One<wbr/>AssetLPToken</span><a href="#tfOneAssetLPToken" 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">tf<wbr/>One<wbr/>AssetLPToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L34">packages/xrpl/src/models/transactions/AMMWithdraw.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L34">packages/xrpl/src/models/transactions/AMMWithdraw.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="tfOneAssetWithdrawAll" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>One<wbr/>Asset<wbr/>Withdraw<wbr/>All</span><a href="#tfOneAssetWithdrawAll" 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">tf<wbr/>One<wbr/>Asset<wbr/>Withdraw<wbr/>All</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L31">packages/xrpl/src/models/transactions/AMMWithdraw.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L31">packages/xrpl/src/models/transactions/AMMWithdraw.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="tfSingleAsset" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>Single<wbr/>Asset</span><a href="#tfSingleAsset" 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">tf<wbr/>Single<wbr/>Asset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L32">packages/xrpl/src/models/transactions/AMMWithdraw.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L32">packages/xrpl/src/models/transactions/AMMWithdraw.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="tfTwoAsset" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>Two<wbr/>Asset</span><a href="#tfTwoAsset" 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">tf<wbr/>Two<wbr/>Asset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L33">packages/xrpl/src/models/transactions/AMMWithdraw.ts:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L33">packages/xrpl/src/models/transactions/AMMWithdraw.ts:33</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="tfWithdrawAll" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tf<wbr/>Withdraw<wbr/>All</span><a href="#tfWithdrawAll" 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">tf<wbr/>Withdraw<wbr/>All</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L30">packages/xrpl/src/models/transactions/AMMWithdraw.ts:30</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/transactions/AMMWithdraw.ts#L30">packages/xrpl/src/models/transactions/AMMWithdraw.ts:30</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -194,6 +194,8 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<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>
@@ -278,6 +280,8 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<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>