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

release: 2.13.0 and pin typedoc@0.25.0 (#2531)

Browse Source 
`typedoc@0.25.1` has breaking changes if you aren not using
`typescript@^5.2`
This commit is contained in:
Caleb Kniffen
2023-10-18 11:11:07 -05:00
committed by GitHub
parent 8b78147945
commit 29c5a70ebc
336 changed files with 11062 additions and 9758 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/interfaces/PathFindCreateRequest.html
View File

@@ -32,7 +32,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<ul class="tsd-hierarchy">
<li><span class="target">PathFindCreateRequest</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/models/methods/pathFind.ts#L11">packages/xrpl/src/models/methods/pathFind.ts:11</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L11">packages/xrpl/src/models/methods/pathFind.ts:11</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">
@@ -60,13 +60,13 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from BasePathFindRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/models/methods/baseMethod.ts#L16">packages/xrpl/src/models/methods/baseMethod.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L16">packages/xrpl/src/models/methods/baseMethod.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;path_find&quot;</span></div><aside class="tsd-sources">
<p>Inherited from BasePathFindRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/models/methods/pathFind.ts#L6">packages/xrpl/src/models/methods/pathFind.ts:6</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L6">packages/xrpl/src/models/methods/pathFind.ts:6</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="destination_account" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>destination_<wbr/>account</span><a href="#destination_account" 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">destination_<wbr/>account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -74,7 +74,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
</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/fa0246eb4/packages/xrpl/src/models/methods/pathFind.ts#L19">packages/xrpl/src/models/methods/pathFind.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L19">packages/xrpl/src/models/methods/pathFind.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="destination_amount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>destination_<wbr/>amount</span><a href="#destination_amount" 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">destination_<wbr/>amount</span><span class="tsd-signature-symbol">:</span> <a href="../types/Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></div>
@@ -83,7 +83,7 @@ transaction.</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/fa0246eb4/packages/xrpl/src/models/methods/pathFind.ts#L24">packages/xrpl/src/models/methods/pathFind.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L24">packages/xrpl/src/models/methods/pathFind.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member 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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">id</span><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>
@@ -94,7 +94,7 @@ know which request prompted which response.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from BasePathFindRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/models/methods/baseMethod.ts#L12">packages/xrpl/src/models/methods/baseMethod.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L12">packages/xrpl/src/models/methods/baseMethod.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="paths" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>paths</span><a href="#paths" 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">paths</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Path.html" class="tsd-signature-type tsd-kind-type-alias">Path</a><span class="tsd-signature-symbol">[]</span></div>
@@ -104,7 +104,7 @@ about, or to check the overall cost to make a payment along a certain path.</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/fa0246eb4/packages/xrpl/src/models/methods/pathFind.ts#L32">packages/xrpl/src/models/methods/pathFind.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L32">packages/xrpl/src/models/methods/pathFind.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="send_max" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>send_<wbr/>max</span><a href="#send_max" 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">send_<wbr/>max</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></div>
@@ -112,7 +112,7 @@ about, or to check the overall cost to make a payment along a certain path.</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/fa0246eb4/packages/xrpl/src/models/methods/pathFind.ts#L26">packages/xrpl/src/models/methods/pathFind.ts:26</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L26">packages/xrpl/src/models/methods/pathFind.ts:26</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="source_account" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>source_<wbr/>account</span><a href="#source_account" 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">source_<wbr/>account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -121,13 +121,13 @@ Account that would be sending a payment.</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/fa0246eb4/packages/xrpl/src/models/methods/pathFind.ts#L17">packages/xrpl/src/models/methods/pathFind.ts:17</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L17">packages/xrpl/src/models/methods/pathFind.ts:17</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="subcommand" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>subcommand</span><a href="#subcommand" 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">subcommand</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;create&quot;</span></div><aside class="tsd-sources">
<p>Overrides BasePathFindRequest.subcommand</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/models/methods/pathFind.ts#L12">packages/xrpl/src/models/methods/pathFind.ts:12</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L12">packages/xrpl/src/models/methods/pathFind.ts:12</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -372,25 +372,26 @@ Account that would be sending a payment.</p>
<li><a href="XChainModifyBridge.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Modify<wbr/>Bridge</span></a></li>
<li><a href="XChainModifyBridgeFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Modify<wbr/>Bridge<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="XRP.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XRP</span></a></li>
<li><a href="../types/AccountObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Account<wbr/>Object</span></a></li>
<li><a href="../types/AccountObjectType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Account<wbr/>Object<wbr/>Type</span></a></li>
<li><a href="../types/Amount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Amount</span></a></li>
<li><a href="../types/BooksSnapshot.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Books<wbr/>Snapshot</span></a></li>
<li><a href="../types/Currency.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Currency</span></a></li>
<li><a href="../types/LedgerDataLabeledLedgerEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ledger<wbr/>Data<wbr/>Labeled<wbr/>Ledger<wbr/>Entry</span></a></li>
<li><a href="../types/LedgerDataLedgerState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ledger<wbr/>Data<wbr/>Ledger<wbr/>State</span></a></li>
<li><a href="../types/LedgerIndex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ledger<wbr/>Index</span></a></li>
<li><a href="../types/Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Node</span></a></li>
<li><a href="../types/Path.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Path</span></a></li>
<li><a href="../types/PathFindRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Path<wbr/>Find<wbr/>Request</span></a></li>
<li><a href="../types/Request.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Request</span></a></li>
<li><a href="../types/Response.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Response</span></a></li>
<li><a href="../types/ServerState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Server<wbr/>State</span></a></li>
<li><a href="../types/SetFee.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Set<wbr/>Fee</span></a></li>
<li><a href="../types/StateAccountingFinal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>State<wbr/>Accounting<wbr/>Final</span></a></li>
<li><a href="../types/Stream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Stream</span></a></li>
<li><a href="../types/StreamType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Stream<wbr/>Type</span></a></li>
<li><a href="../types/Transaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Transaction</span></a></li>
<li><a href="../types/AccountObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Account<wbr/>Object</span></a></li>
<li><a href="../types/AccountObjectType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Account<wbr/>Object<wbr/>Type</span></a></li>
<li><a href="../types/Amount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Amount</span></a></li>
<li><a href="../types/BooksSnapshot.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Books<wbr/>Snapshot</span></a></li>
<li><a href="../types/Currency.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Currency</span></a></li>
<li><a href="../types/LedgerDataLabeledLedgerEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Data<wbr/>Labeled<wbr/>Ledger<wbr/>Entry</span></a></li>
<li><a href="../types/LedgerDataLedgerState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Data<wbr/>Ledger<wbr/>State</span></a></li>
<li><a href="../types/LedgerIndex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Index</span></a></li>
<li><a href="../types/Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Node</span></a></li>
<li><a href="../types/Path.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Path</span></a></li>
<li><a href="../types/PathFindRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Path<wbr/>Find<wbr/>Request</span></a></li>
<li><a href="../types/PseudoTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pseudo<wbr/>Transaction</span></a></li>
<li><a href="../types/Request.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Request</span></a></li>
<li><a href="../types/Response.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Response</span></a></li>
<li><a href="../types/ServerState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Server<wbr/>State</span></a></li>
<li><a href="../types/SetFee.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Set<wbr/>Fee</span></a></li>
<li><a href="../types/StateAccountingFinal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>State<wbr/>Accounting<wbr/>Final</span></a></li>
<li><a href="../types/Stream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Stream</span></a></li>
<li><a href="../types/StreamType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Stream<wbr/>Type</span></a></li>
<li><a href="../types/Transaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Transaction</span></a></li>
<li><a href="../variables/hashes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>hashes</span></a></li>
<li><a href="../functions/authorizeChannel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>authorize<wbr/>Channel</span></a></li>
<li><a href="../functions/classicAddressToXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>classic<wbr/>Address<wbr/>ToXAddress</span></a></li>
@@ -451,5 +452,5 @@ Account that would be sending a payment.</p>
<li><a href="../functions/xAddressToClassicAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>x<wbr/>Address<wbr/>To<wbr/>Classic<wbr/>Address</span></a></li>
<li><a href="../functions/xrpToDrops.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>xrp<wbr/>To<wbr/>Drops</span></a></li></ul></nav></div></div></div>
<div class="tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div></body></html>