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: 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

60
docs/classes/NotFoundError.html
View File

@@ -33,7 +33,7 @@ From rippled.</p>
<ul class="tsd-hierarchy">
<li><span class="target">NotFoundError</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/errors.ts#L137">packages/xrpl/src/errors.ts:137</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/errors.ts#L137">packages/xrpl/src/errors.ts:137</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">
@@ -73,13 +73,12 @@ From rippled.</p>
<li>
<h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Not found&#39;</span></h5>
<div class="tsd-comment tsd-typography"><p>The error message. Defaults to &quot;Not found&quot;.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="NotFoundError.html" class="tsd-signature-type tsd-kind-class">NotFoundError</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/errors.ts#L143">packages/xrpl/src/errors.ts:143</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/errors.ts#L143">packages/xrpl/src/errors.ts:143</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
@@ -87,19 +86,19 @@ From rippled.</p>
<div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>message</span><a href="#message" 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">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -154,7 +153,7 @@ us to customize its output:
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/errors.ts#L54">packages/xrpl/src/errors.ts:54</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/errors.ts#L54">packages/xrpl/src/errors.ts:54</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
@@ -167,7 +166,7 @@ us to customize its output:
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/fa0246eb4/packages/xrpl/src/errors.ts#L38">packages/xrpl/src/errors.ts:38</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/errors.ts#L38">packages/xrpl/src/errors.ts:38</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@@ -181,7 +180,7 @@ us to customize its output:
<li>
<h5><span class="tsd-kind-parameter">targetObject</span>: <span class="tsd-signature-type">object</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type ">Function</span></h5></li></ul></div>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">constructorOpt</span>: <span class="tsd-signature-type ">Function</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p>
@@ -432,25 +431,26 @@ us to customize its output:
<li><a href="../interfaces/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="../interfaces/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="../interfaces/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>
@@ -511,5 +511,5 @@ us to customize its output:
<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>