mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-08-21 07:30:52 +00:00
update reference docs and add readme to homepage (#2112)
This commit is contained in:
jonathanlei
@@ -31,7 +31,7 @@ using <a href="https://github.com/XRPL-Labs/xrpl-client/">xrpl-client</a></p>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">BroadcastClient</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/BroadcastClient.ts#L18">packages/xrpl/src/client/BroadcastClient.ts:18</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/BroadcastClient.ts#L18">packages/xrpl/src/client/BroadcastClient.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">
|
||||
@@ -127,18 +127,18 @@ using <a href="https://github.com/XRPL-Labs/xrpl-client/">xrpl-client</a></p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides <a href="Client.html">Client</a>.<a href="Client.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/BroadcastClient.ts#L28">packages/xrpl/src/client/BroadcastClient.ts:28</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/BroadcastClient.ts#L28">packages/xrpl/src/client/BroadcastClient.ts:28</a></li></ul></aside></li></ul></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Abstraction</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="getBalances" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Balances</span><a href="#getBalances" 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">get<wbr/>Balances<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getBalances</span></div>
|
||||
<div class="tsd-signature">get<wbr/>Balances<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getBalances</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-4.__type-5"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-4.__type-5"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Get XRP/non-XRP balances for an account.</p>
|
||||
|
||||
@@ -156,7 +156,7 @@ using <a href="https://github.com/XRPL-Labs/xrpl-client/">xrpl-client</a></p>
|
||||
<div class="tsd-comment tsd-typography"><p>Address of the account to retrieve balances for.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Allows the client to specify a ledger_hash, ledger_index,
|
||||
filter by peer, and/or limit number of balances.</p>
|
||||
</div>
|
||||
@@ -179,10 +179,10 @@ ledger_index.</p>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Filter balances by peer.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getBalances">getBalances</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L620">packages/xrpl/src/client/index.ts:620</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L620">packages/xrpl/src/client/index.ts:620</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="getLedgerIndex" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Ledger<wbr/>Index</span><a href="#getLedgerIndex" 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">get<wbr/>Ledger<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getLedgerIndex</span></div>
|
||||
@@ -207,16 +207,16 @@ ledger_index.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getLedgerIndex">getLedgerIndex</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L630">packages/xrpl/src/client/index.ts:630</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L630">packages/xrpl/src/client/index.ts:630</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="getOrderbook" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Orderbook</span><a href="#getOrderbook" 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">get<wbr/>Orderbook<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getOrderbook</span></div>
|
||||
<div class="tsd-signature">get<wbr/>Orderbook<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getOrderbook</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-8.__type-9"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-8.__type-9"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Fetch orderbook (buy/sell orders) between two accounts.</p>
|
||||
|
||||
@@ -240,7 +240,7 @@ offer would pay, as an object with <code>currency</code> and <code>issuer</code>
|
||||
offer would receive, as an object with <code>currency</code> and <code>issuer</code> fields.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Options allowing the client to specify ledger_index,
|
||||
ledger_hash, filter by taker, and/or limit number of orders.</p>
|
||||
</div>
|
||||
@@ -263,23 +263,23 @@ the order book. Defaults to 20.</p>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Filter orders by taker.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getOrderbook">getOrderbook</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L625">packages/xrpl/src/client/index.ts:625</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L625">packages/xrpl/src/client/index.ts:625</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="getXrpBalance" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Xrp<wbr/>Balance</span><a href="#getXrpBalance" 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">get<wbr/>Xrp<wbr/>Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getXrpBalance</span></div>
|
||||
<div class="tsd-signature">get<wbr/>Xrp<wbr/>Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getXrpBalance</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-10.__type-11"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-10.__type-11"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Get the XRP balance for an account.</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Client</span><span class="hl-1">(</span><span class="hl-4">wss</span><span class="hl-1">:</span><span class="hl-5">//s.altnet.rippletest.net:51233)</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-4">balance</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-3">getXrpBalance</span><span class="hl-1">(</span><span class="hl-7">'rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn'</span><span class="hl-1">)</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">balance</span><span class="hl-1">)</span><br/><span class="hl-5">/// '200'</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-0">wss</span><span class="hl-1">:</span><span class="hl-7">//s.altnet.rippletest.net:51233)</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-0">balance</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">getXrpBalance</span><span class="hl-1">(</span><span class="hl-5">'rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn'</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">balance</span><span class="hl-1">)</span><br/><span class="hl-7">/// '200'</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Returns</h3><p>The XRP balance of the account (as a string).</p>
|
||||
@@ -296,7 +296,7 @@ the order book. Defaults to 20.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>Address of the account to retrieve XRP balance.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Options to include for getting the XRP balance.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -313,7 +313,7 @@ ledger_index.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getXrpBalance">getXrpBalance</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L615">packages/xrpl/src/client/index.ts:615</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L615">packages/xrpl/src/client/index.ts:615</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Core</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="autofill" class="tsd-anchor"></a>
|
||||
@@ -333,11 +333,11 @@ flags interfaces into numbers.</p>
|
||||
|
||||
<h3>Returns</h3><p>The autofilled transaction.</p>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
<h4 class="tsd-type-parameters-title">Type Parameters</h4>
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h4>Type Parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></div>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></section>
|
||||
<div class="tsd-parameters">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameter-list">
|
||||
@@ -357,16 +357,16 @@ Only used for multisigned transactions.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#autofill">autofill</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L596">packages/xrpl/src/client/index.ts:596</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L596">packages/xrpl/src/client/index.ts:596</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="submit" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">submit</span><a href="#submit" 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">submit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submit</span></div>
|
||||
<div class="tsd-signature">submit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submit</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-14.__type-15"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-14.__type-15"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Submits a signed/unsigned transaction.
|
||||
Steps performed on a transaction:</p>
|
||||
@@ -392,7 +392,7 @@ Steps performed on a transaction:</p>
|
||||
<div class="tsd-comment tsd-typography"><p>A transaction to autofill, sign & encode, and submit.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options used to sign and submit a transaction.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -411,16 +411,16 @@ Steps performed on a transaction:</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#submit">submit</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L601">packages/xrpl/src/client/index.ts:601</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L601">packages/xrpl/src/client/index.ts:601</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="submitAndWait" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">submit<wbr/>And<wbr/>Wait</span><a href="#submitAndWait" 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">submit<wbr/>And<wbr/>Wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submitAndWait</span></div>
|
||||
<div class="tsd-signature">submit<wbr/>And<wbr/>Wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submitAndWait</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-16.__type-17"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-16.__type-17"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Asynchronously submits a transaction and verifies that it has been included in a
|
||||
validated ledger (or has errored/will not be included for some reason).
|
||||
@@ -440,7 +440,7 @@ See <a href="https://xrpl.org/reliable-transaction-submission.html">Reliable Tra
|
||||
<div class="tsd-comment tsd-typography"><p>A transaction to autofill, sign & encode, and submit.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options used to sign and submit a transaction.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -459,22 +459,22 @@ See <a href="https://xrpl.org/reliable-transaction-submission.html">Reliable Tra
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#submitAndWait">submitAndWait</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L605">packages/xrpl/src/client/index.ts:605</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L605">packages/xrpl/src/client/index.ts:605</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Faucet</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fundWallet" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">fund<wbr/>Wallet</span><a href="#fundWallet" 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">fund<wbr/>Wallet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = fundWallet</span></div>
|
||||
<div class="tsd-signature">fund<wbr/>Wallet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = fundWallet</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-2.__type-3"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-2.__type-3"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Generates a random wallet with some amount of XRP (usually 1000 XRP).</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-typescript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">api</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-4">xrpl</span><span class="hl-1">.</span><span class="hl-3">Client</span><span class="hl-1">(</span><span class="hl-7">"wss://s.altnet.rippletest.net:51233"</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">connect</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">wallet</span><span class="hl-1">, </span><span class="hl-2">balance</span><span class="hl-1"> } = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">fundWallet</span><span class="hl-1">()</span>
|
||||
<h3>Example</h3><pre><code class="language-typescript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">api</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-0">xrpl</span><span class="hl-1">.</span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">"wss://s.altnet.rippletest.net:51233"</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">wallet</span><span class="hl-1">, </span><span class="hl-3">balance</span><span class="hl-1"> } = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">fundWallet</span><span class="hl-1">()</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Returns</h3><p>A Wallet on the Testnet or Devnet that contains some amount of XRP,
|
||||
@@ -494,7 +494,7 @@ and that wallet's balance in XRP.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-symbol">{ </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>See below.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -506,10 +506,10 @@ automatically. In other environments, or if you would like to customize the
|
||||
faucet host in devnet or testnet, you should provide the host using this
|
||||
option.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#fundWallet">fundWallet</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L635">packages/xrpl/src/client/index.ts:635</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L635">packages/xrpl/src/client/index.ts:635</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Fee</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="feeCushion" class="tsd-anchor"></a>
|
||||
@@ -520,7 +520,7 @@ required fee rises during submission of a transaction. Defaults to 1.2.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#feeCushion">feeCushion</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L192">packages/xrpl/src/client/index.ts:192</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L192">packages/xrpl/src/client/index.ts:192</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="maxFeeXRP" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">max<wbr/>FeeXRP</span><a href="#maxFeeXRP" 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">max<wbr/>FeeXRP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
@@ -529,7 +529,7 @@ number. Defaults to '2'.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#maxFeeXRP">maxFeeXRP</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L200">packages/xrpl/src/client/index.ts:200</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L200">packages/xrpl/src/client/index.ts:200</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Network</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="url" class="tsd-anchor"></a>
|
||||
@@ -544,7 +544,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from Client.url</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L280">packages/xrpl/src/client/index.ts:280</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L280">packages/xrpl/src/client/index.ts:280</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="connect" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">connect</span><a href="#connect" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -557,7 +557,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#connect">connect</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L565">packages/xrpl/src/client/index.ts:565</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L565">packages/xrpl/src/client/index.ts:565</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="disconnect" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">disconnect</span><a href="#disconnect" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -570,7 +570,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#disconnect">disconnect</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L575">packages/xrpl/src/client/index.ts:575</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L575">packages/xrpl/src/client/index.ts:575</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isConnected" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">is<wbr/>Connected</span><a href="#isConnected" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -583,7 +583,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#isConnected">isConnected</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L589">packages/xrpl/src/client/index.ts:589</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L589">packages/xrpl/src/client/index.ts:589</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="on" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">on</span><a href="#on" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -591,7 +591,7 @@ number. Defaults to '2'.</p>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">api</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Client</span><span class="hl-1">(</span><span class="hl-7">'wss://s.altnet.rippletest.net:51233'</span><span class="hl-1">)</span><br/><br/><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'transactions'</span><span class="hl-1">, (</span><span class="hl-4">tx</span><span class="hl-1">: </span><span class="hl-8">TransactionStream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">"Received Transaction"</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">tx</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">connect</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">response</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">request</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">command:</span><span class="hl-1"> </span><span class="hl-7">'subscribe'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">streams:</span><span class="hl-1"> [</span><span class="hl-7">'transactions_proposed'</span><span class="hl-1">]</span><br/><span class="hl-1">})</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">api</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">'wss://s.altnet.rippletest.net:51233'</span><span class="hl-1">)</span><br/><br/><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'transactions'</span><span class="hl-1">, (</span><span class="hl-0">tx</span><span class="hl-1">: </span><span class="hl-8">TransactionStream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">"Received Transaction"</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">tx</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">response</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">request</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">'subscribe'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">streams:</span><span class="hl-1"> [</span><span class="hl-5">'transactions_proposed'</span><span class="hl-1">]</span><br/><span class="hl-1">})</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -610,7 +610,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L435">packages/xrpl/src/client/index.ts:435</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L435">packages/xrpl/src/client/index.ts:435</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-2">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"disconnected"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-2" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -640,7 +640,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L436">packages/xrpl/src/client/index.ts:436</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L436">packages/xrpl/src/client/index.ts:436</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-3">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ledgerClosed"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>ledger<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerStream.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -670,7 +670,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L437">packages/xrpl/src/client/index.ts:437</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L437">packages/xrpl/src/client/index.ts:437</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-4">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"validationReceived"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>validation<span class="tsd-signature-symbol">: </span><a href="../interfaces/ValidationStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-4" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -700,7 +700,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L441">packages/xrpl/src/client/index.ts:441</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L441">packages/xrpl/src/client/index.ts:441</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-5">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"transaction"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../interfaces/TransactionStream.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-5" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -730,7 +730,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L445">packages/xrpl/src/client/index.ts:445</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L445">packages/xrpl/src/client/index.ts:445</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-6">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"peerStatusChange"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">: </span><a href="../interfaces/PeerStatusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerStatusStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-6" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -760,7 +760,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L449">packages/xrpl/src/client/index.ts:449</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L449">packages/xrpl/src/client/index.ts:449</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-7">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"consensusPhase"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>phase<span class="tsd-signature-symbol">: </span><a href="../interfaces/ConsensusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ConsensusStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-7" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -790,7 +790,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L453">packages/xrpl/src/client/index.ts:453</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L453">packages/xrpl/src/client/index.ts:453</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-8">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"path_find"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><a href="../interfaces/PathFindStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-8" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -820,7 +820,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L457">packages/xrpl/src/client/index.ts:457</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L457">packages/xrpl/src/client/index.ts:457</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-9">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-9" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -850,7 +850,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L459">packages/xrpl/src/client/index.ts:459</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L459">packages/xrpl/src/client/index.ts:459</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="request" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">request</span><a href="#request" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -864,7 +864,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L287">packages/xrpl/src/client/index.ts:287</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L287">packages/xrpl/src/client/index.ts:287</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-2">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountCurrenciesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-2" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -880,7 +880,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L290">packages/xrpl/src/client/index.ts:290</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L290">packages/xrpl/src/client/index.ts:290</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-3">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -896,7 +896,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L293">packages/xrpl/src/client/index.ts:293</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L293">packages/xrpl/src/client/index.ts:293</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-4">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-4" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -912,7 +912,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L294">packages/xrpl/src/client/index.ts:294</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L294">packages/xrpl/src/client/index.ts:294</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-5">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountNFTsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-5" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -928,7 +928,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L295">packages/xrpl/src/client/index.ts:295</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L295">packages/xrpl/src/client/index.ts:295</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-6">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-6" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -944,7 +944,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L296">packages/xrpl/src/client/index.ts:296</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L296">packages/xrpl/src/client/index.ts:296</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-7">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-7" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -960,7 +960,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L299">packages/xrpl/src/client/index.ts:299</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L299">packages/xrpl/src/client/index.ts:299</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-8">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-8" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -976,7 +976,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L300">packages/xrpl/src/client/index.ts:300</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L300">packages/xrpl/src/client/index.ts:300</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-9">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-9" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -992,7 +992,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L301">packages/xrpl/src/client/index.ts:301</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L301">packages/xrpl/src/client/index.ts:301</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-10">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ChannelVerifyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-10" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1008,7 +1008,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L302">packages/xrpl/src/client/index.ts:302</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L302">packages/xrpl/src/client/index.ts:302</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-11">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/DepositAuthorizedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-11" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1024,7 +1024,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L303">packages/xrpl/src/client/index.ts:303</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L303">packages/xrpl/src/client/index.ts:303</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-12">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/FeeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-12" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1040,7 +1040,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L306">packages/xrpl/src/client/index.ts:306</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L306">packages/xrpl/src/client/index.ts:306</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-13">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/GatewayBalancesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-13" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1056,7 +1056,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-14">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-14" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1072,7 +1072,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L310">packages/xrpl/src/client/index.ts:310</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L310">packages/xrpl/src/client/index.ts:310</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-15">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerClosedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-15" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1088,7 +1088,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L311">packages/xrpl/src/client/index.ts:311</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L311">packages/xrpl/src/client/index.ts:311</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-16">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerCurrentRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-16" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1104,7 +1104,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L312">packages/xrpl/src/client/index.ts:312</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L312">packages/xrpl/src/client/index.ts:312</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-17">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-17" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1120,7 +1120,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L313">packages/xrpl/src/client/index.ts:313</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L313">packages/xrpl/src/client/index.ts:313</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-18">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-18" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1136,7 +1136,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L314">packages/xrpl/src/client/index.ts:314</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L314">packages/xrpl/src/client/index.ts:314</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-19">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ManifestRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-19" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1152,7 +1152,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L315">packages/xrpl/src/client/index.ts:315</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L315">packages/xrpl/src/client/index.ts:315</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-20">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NFTBuyOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTBuyOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-20" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1168,7 +1168,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTBuyOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L316">packages/xrpl/src/client/index.ts:316</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L316">packages/xrpl/src/client/index.ts:316</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-21">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NFTSellOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTSellOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-21" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1184,7 +1184,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTSellOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L317">packages/xrpl/src/client/index.ts:317</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L317">packages/xrpl/src/client/index.ts:317</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-22">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NoRippleCheckRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-22" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1200,7 +1200,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L318">packages/xrpl/src/client/index.ts:318</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L318">packages/xrpl/src/client/index.ts:318</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-23">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../types/PathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Type alias">PathFindRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-23" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1216,7 +1216,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L319">packages/xrpl/src/client/index.ts:319</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L319">packages/xrpl/src/client/index.ts:319</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-24">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/PingRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PingRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-24" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1232,7 +1232,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L320">packages/xrpl/src/client/index.ts:320</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L320">packages/xrpl/src/client/index.ts:320</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-25">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/RandomRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-25" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1248,7 +1248,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L321">packages/xrpl/src/client/index.ts:321</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L321">packages/xrpl/src/client/index.ts:321</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-26">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/RipplePathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-26" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1264,7 +1264,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L322">packages/xrpl/src/client/index.ts:322</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L322">packages/xrpl/src/client/index.ts:322</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-27">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServerInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-27" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1280,7 +1280,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L325">packages/xrpl/src/client/index.ts:325</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L325">packages/xrpl/src/client/index.ts:325</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-28">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServerStateRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-28" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1296,7 +1296,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L326">packages/xrpl/src/client/index.ts:326</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L326">packages/xrpl/src/client/index.ts:326</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-29">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubmitRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-29" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1312,7 +1312,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L327">packages/xrpl/src/client/index.ts:327</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L327">packages/xrpl/src/client/index.ts:327</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-30">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubmitMultisignedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-30" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1328,7 +1328,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L328">packages/xrpl/src/client/index.ts:328</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L328">packages/xrpl/src/client/index.ts:328</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-31">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-31" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1344,7 +1344,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L331">packages/xrpl/src/client/index.ts:331</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L331">packages/xrpl/src/client/index.ts:331</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-32">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/UnsubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-32" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1360,7 +1360,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L332">packages/xrpl/src/client/index.ts:332</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L332">packages/xrpl/src/client/index.ts:332</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-33">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/TransactionEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-33" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1376,7 +1376,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L333">packages/xrpl/src/client/index.ts:333</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L333">packages/xrpl/src/client/index.ts:333</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-34">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/TxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-34" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1392,7 +1392,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L336">packages/xrpl/src/client/index.ts:336</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L336">packages/xrpl/src/client/index.ts:336</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-35">request<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><a href="#request.request-35" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1400,13 +1400,13 @@ additional request body parameters.</p>
|
||||
|
||||
<h3>Returns</h3><p>The response from the server.</p>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
<h4 class="tsd-type-parameters-title">Type Parameters</h4>
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h4>Type Parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>R<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">BaseRequest</span></h4></li>
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">BaseResponse</span></h4></li></ul></div>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">BaseResponse</span></h4></li></ul></section>
|
||||
<div class="tsd-parameters">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameter-list">
|
||||
@@ -1415,7 +1415,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L337">packages/xrpl/src/client/index.ts:337</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L337">packages/xrpl/src/client/index.ts:337</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="requestAll" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">request<wbr/>All</span><a href="#requestAll" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -1429,7 +1429,7 @@ additional request body parameters.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestAll">requestAll</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L475">packages/xrpl/src/client/index.ts:475</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L475">packages/xrpl/src/client/index.ts:475</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-2">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-2" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1454,7 +1454,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestAll">requestAll</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L478">packages/xrpl/src/client/index.ts:478</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L478">packages/xrpl/src/client/index.ts:478</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-3">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1479,7 +1479,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestAll">requestAll</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L481">packages/xrpl/src/client/index.ts:481</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L481">packages/xrpl/src/client/index.ts:481</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-4">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-4" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1504,7 +1504,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestAll">requestAll</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L484">packages/xrpl/src/client/index.ts:484</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L484">packages/xrpl/src/client/index.ts:484</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-5">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-5" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1529,7 +1529,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestAll">requestAll</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L487">packages/xrpl/src/client/index.ts:487</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L487">packages/xrpl/src/client/index.ts:487</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-6">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-6" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1554,7 +1554,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestAll">requestAll</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L488">packages/xrpl/src/client/index.ts:488</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L488">packages/xrpl/src/client/index.ts:488</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-7">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-7" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1579,7 +1579,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestAll">requestAll</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="requestNextPage" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">request<wbr/>Next<wbr/>Page</span><a href="#requestNextPage" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -1595,7 +1595,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestNextPage">requestNextPage</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L369">packages/xrpl/src/client/index.ts:369</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L369">packages/xrpl/src/client/index.ts:369</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-2">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-2" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1616,7 +1616,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestNextPage">requestNextPage</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L373">packages/xrpl/src/client/index.ts:373</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L373">packages/xrpl/src/client/index.ts:373</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-3">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1637,7 +1637,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestNextPage">requestNextPage</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L377">packages/xrpl/src/client/index.ts:377</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L377">packages/xrpl/src/client/index.ts:377</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-4">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-4" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1658,7 +1658,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestNextPage">requestNextPage</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L381">packages/xrpl/src/client/index.ts:381</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L381">packages/xrpl/src/client/index.ts:381</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-5">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-5" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1679,7 +1679,7 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestNextPage">requestNextPage</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L385">packages/xrpl/src/client/index.ts:385</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L385">packages/xrpl/src/client/index.ts:385</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-6">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-6" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1700,20 +1700,20 @@ requests as needed.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#requestNextPage">requestNextPage</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L389">packages/xrpl/src/client/index.ts:389</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L389">packages/xrpl/src/client/index.ts:389</a></li></ul></aside></li></ul></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Other</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="clients" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">clients</span><a href="#clients" 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">clients<span class="tsd-signature-symbol">:</span> <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/BroadcastClient.ts#L19">packages/xrpl/src/client/BroadcastClient.ts:19</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/BroadcastClient.ts#L19">packages/xrpl/src/client/BroadcastClient.ts:19</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="connection" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">connection</span><a href="#connection" 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">connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Connection</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#connection">connection</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L184">packages/xrpl/src/client/index.ts:184</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L184">packages/xrpl/src/client/index.ts:184</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="prepareTransaction" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">prepare<wbr/>Transaction</span><a href="#prepareTransaction" 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">prepare<wbr/>Transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, signersCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = autofill</span></div>
|
||||
@@ -1731,11 +1731,11 @@ flags interfaces into numbers.</p>
|
||||
|
||||
<h3>Returns</h3><p>The autofilled transaction.</p>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
<h4 class="tsd-type-parameters-title">Type Parameters</h4>
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h4>Type Parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></div>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></section>
|
||||
<div class="tsd-parameters">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameter-list">
|
||||
@@ -1755,7 +1755,7 @@ Only used for multisigned transactions.</p>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#prepareTransaction">prepareTransaction</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L610">packages/xrpl/src/client/index.ts:610</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L610">packages/xrpl/src/client/index.ts:610</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" 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">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="BroadcastClient.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources">
|
||||
@@ -1828,7 +1828,7 @@ regular <code>'error'</code> listener is installed.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>Synchronously calls each of the listeners registered for the event named<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
||||
to each.</p>
|
||||
<p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">EventEmitter</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// First listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">firstListener</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Helloooo! first listener'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Second listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">secondListener</span><span class="hl-1">(</span><span class="hl-4">arg1</span><span class="hl-1">, </span><span class="hl-4">arg2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">`event with parameters </span><span class="hl-0">${</span><span class="hl-4">arg1</span><span class="hl-0">}</span><span class="hl-7">, </span><span class="hl-0">${</span><span class="hl-4">arg2</span><span class="hl-0">}</span><span class="hl-7"> in second listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Third listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">thirdListener</span><span class="hl-1">(...</span><span class="hl-4">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">parameters</span><span class="hl-1"> = </span><span class="hl-4">args</span><span class="hl-1">.</span><span class="hl-3">join</span><span class="hl-1">(</span><span class="hl-7">', '</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">`event with parameters </span><span class="hl-0">${</span><span class="hl-4">parameters</span><span class="hl-0">}</span><span class="hl-7"> in third listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">listeners</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">));</span><br/><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-9">1</span><span class="hl-1">, </span><span class="hl-9">2</span><span class="hl-1">, </span><span class="hl-9">3</span><span class="hl-1">, </span><span class="hl-9">4</span><span class="hl-1">, </span><span class="hl-9">5</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// [</span><br/><span class="hl-5">// [Function: firstListener],</span><br/><span class="hl-5">// [Function: secondListener],</span><br/><span class="hl-5">// [Function: thirdListener]</span><br/><span class="hl-5">// ]</span><br/><span class="hl-5">// Helloooo! first listener</span><br/><span class="hl-5">// event with parameters 1, 2 in second listener</span><br/><span class="hl-5">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1"> = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEmitter</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// First listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">firstListener</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Helloooo! first listener'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-7">// Second listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">secondListener</span><span class="hl-1">(</span><span class="hl-0">arg1</span><span class="hl-1">, </span><span class="hl-0">arg2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">`event with parameters </span><span class="hl-2">${</span><span class="hl-0">arg1</span><span class="hl-2">}</span><span class="hl-5">, </span><span class="hl-2">${</span><span class="hl-0">arg2</span><span class="hl-2">}</span><span class="hl-5"> in second listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-7">// Third listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">thirdListener</span><span class="hl-1">(...</span><span class="hl-0">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">parameters</span><span class="hl-1"> = </span><span class="hl-0">args</span><span class="hl-1">.</span><span class="hl-4">join</span><span class="hl-1">(</span><span class="hl-5">', '</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">`event with parameters </span><span class="hl-2">${</span><span class="hl-0">parameters</span><span class="hl-2">}</span><span class="hl-5"> in third listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">listeners</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">));</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-9">1</span><span class="hl-1">, </span><span class="hl-9">2</span><span class="hl-1">, </span><span class="hl-9">3</span><span class="hl-1">, </span><span class="hl-9">4</span><span class="hl-1">, </span><span class="hl-9">5</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// [</span><br/><span class="hl-7">// [Function: firstListener],</span><br/><span class="hl-7">// [Function: secondListener],</span><br/><span class="hl-7">// [Function: thirdListener]</span><br/><span class="hl-7">// ]</span><br/><span class="hl-7">// Helloooo! first listener</span><br/><span class="hl-7">// event with parameters 1, 2 in second listener</span><br/><span class="hl-7">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.1.26</p>
|
||||
@@ -1851,7 +1851,7 @@ to each.</p>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns an array listing the events for which the emitter has registered
|
||||
listeners. The values in the array are strings or <code>Symbol</code>s.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">EventEmitter</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEE</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'bar'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">sym</span><span class="hl-1"> = </span><span class="hl-8">Symbol</span><span class="hl-1">(</span><span class="hl-7">'symbol'</span><span class="hl-1">);</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">sym</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">eventNames</span><span class="hl-1">());</span><br/><span class="hl-5">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1"> = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEE</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'bar'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">sym</span><span class="hl-1"> = </span><span class="hl-4">Symbol</span><span class="hl-1">(</span><span class="hl-5">'symbol'</span><span class="hl-1">);</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-0">sym</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">eventNames</span><span class="hl-1">());</span><br/><span class="hl-7">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v6.0.0</p>
|
||||
@@ -1885,7 +1885,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="Broadcast
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/BroadcastClient.ts#L66">packages/xrpl/src/client/BroadcastClient.ts:66</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/BroadcastClient.ts#L66">packages/xrpl/src/client/BroadcastClient.ts:66</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span class="deprecated">listener<wbr/>Count</span><a href="#listenerCount" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -1912,7 +1912,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="Broadcast
|
||||
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1">listeners<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">util</span><span class="hl-1">.</span><span class="hl-3">inspect</span><span class="hl-1">(</span><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">listeners</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">)));</span><br/><span class="hl-5">// Prints: [ [Function] ]</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">util</span><span class="hl-1">.</span><span class="hl-4">inspect</span><span class="hl-1">(</span><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">listeners</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">)));</span><br/><span class="hl-7">// Prints: [ [Function] ]</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.1.26</p>
|
||||
@@ -1964,12 +1964,12 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="Broadcast
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code>. The
|
||||
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
|
||||
event listener to the beginning of the listeners array.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEE</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'a'</span><span class="hl-1">));</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">prependOnceListener</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'b'</span><span class="hl-1">));</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// b</span><br/><span class="hl-5">// a</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEE</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'a'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">prependOnceListener</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'b'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// b</span><br/><span class="hl-7">// a</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.3.0</p>
|
||||
@@ -2009,7 +2009,7 @@ event listener to the beginning of the listeners array.</p>
|
||||
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
||||
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
||||
times.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">prependListener</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">prependListener</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
@@ -2048,7 +2048,7 @@ times.</p>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code> to the_beginning_ of the listeners array. The next time <code>eventName</code> is triggered, this
|
||||
listener is removed, and then invoked.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">prependOnceListener</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">prependOnceListener</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
@@ -2087,7 +2087,7 @@ listener is removed, and then invoked.</p>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
||||
including any wrappers (such as those created by <code>.once()</code>).</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'log once'</span><span class="hl-1">));</span><br/><br/><span class="hl-5">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-5">// `listener` which contains the original listener bound above</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">listeners</span><span class="hl-1"> = </span><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">rawListeners</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">logFnWrapper</span><span class="hl-1"> = </span><span class="hl-4">listeners</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">];</span><br/><br/><span class="hl-5">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-4">logFnWrapper</span><span class="hl-1">.</span><span class="hl-3">listener</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-3">logFnWrapper</span><span class="hl-1">();</span><br/><br/><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'log persistently'</span><span class="hl-1">));</span><br/><span class="hl-5">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">newListeners</span><span class="hl-1"> = </span><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">rawListeners</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Logs "log persistently" twice</span><br/><span class="hl-4">newListeners</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">]();</span><br/><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">);</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">emitter</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'log once'</span><span class="hl-1">));</span><br/><br/><span class="hl-7">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-7">// `listener` which contains the original listener bound above</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">listeners</span><span class="hl-1"> = </span><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">rawListeners</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">logFnWrapper</span><span class="hl-1"> = </span><span class="hl-0">listeners</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">];</span><br/><br/><span class="hl-7">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-0">logFnWrapper</span><span class="hl-1">.</span><span class="hl-4">listener</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-4">logFnWrapper</span><span class="hl-1">();</span><br/><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'log persistently'</span><span class="hl-1">));</span><br/><span class="hl-7">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">newListeners</span><span class="hl-1"> = </span><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">rawListeners</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Logs "log persistently" twice</span><br/><span class="hl-0">newListeners</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">]();</span><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v9.4.0</p>
|
||||
@@ -2129,7 +2129,7 @@ component or module (e.g. sockets or file streams).</p>
|
||||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#removeListener.removeListener-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callback</span><span class="hl-1"> = (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, </span><span class="hl-4">callback</span><span class="hl-1">);</span><br/><span class="hl-5">// ...</span><br/><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, </span><span class="hl-4">callback</span><span class="hl-1">);</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">callback</span><span class="hl-1"> = (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, </span><span class="hl-0">callback</span><span class="hl-1">);</span><br/><span class="hl-7">// ...</span><br/><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">removeListener</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, </span><span class="hl-0">callback</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
<p><code>removeListener()</code> will remove, at most, one instance of a listener from the
|
||||
listener array. If any single listener has been added multiple times to the
|
||||
@@ -2138,7 +2138,7 @@ called multiple times to remove each instance.</p>
|
||||
<p>Once an event is emitted, all listeners attached to it at the
|
||||
time of emitting are called in order. This implies that any<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and_before_ the last listener finishes execution will
|
||||
not remove them from<code>emit()</code> in progress. Subsequent events behave as expected.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">MyEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callbackA</span><span class="hl-1"> = () </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'A'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-4">callbackB</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callbackB</span><span class="hl-1"> = () </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'B'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-4">callbackA</span><span class="hl-1">);</span><br/><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-4">callbackB</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-5">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span><br/><span class="hl-5">// B</span><br/><br/><span class="hl-5">// callbackB is now removed.</span><br/><span class="hl-5">// Internal listener array [callbackA]</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEmitter</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">MyEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">callbackA</span><span class="hl-1"> = () </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'A'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">removeListener</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackB</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">callbackB</span><span class="hl-1"> = () </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'B'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackA</span><span class="hl-1">);</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackB</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-7">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span><br/><span class="hl-7">// B</span><br/><br/><span class="hl-7">// callbackB is now removed.</span><br/><span class="hl-7">// Internal listener array [callbackA]</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span>
|
||||
</code></pre>
|
||||
<p>Because listeners are managed using an internal array, calling this will
|
||||
change the position indices of any listener registered <em>after</em> the listener
|
||||
@@ -2148,7 +2148,7 @@ the <code>emitter.listeners()</code> method will need to be recreated.</p>
|
||||
<p>When a single function has been added as a handler multiple times for a single
|
||||
event (as in the example below), <code>removeListener()</code> will remove the most
|
||||
recently added instance. In the example the <code>once('ping')</code>listener is removed:</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">pong</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'pong'</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">, </span><span class="hl-4">pong</span><span class="hl-1">);</span><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">, </span><span class="hl-4">pong</span><span class="hl-1">);</span><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">, </span><span class="hl-4">pong</span><span class="hl-1">);</span><br/><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">);</span><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">);</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">pong</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'pong'</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">removeListener</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
@@ -2208,7 +2208,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
||||
the emitter.</p>
|
||||
<p>For <code>EventTarget</code>s this is the only way to get the event listeners for the
|
||||
event target. This is useful for debugging and diagnostic purposes.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">getEventListeners</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">listener</span><span class="hl-1"> = () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-4">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">getEventListeners</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-1">}</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">et</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">listener</span><span class="hl-1"> = () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">et</span><span class="hl-1">.</span><span class="hl-3">addEventListener</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-4">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">getEventListeners</span><span class="hl-1">(</span><span class="hl-4">et</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-1">}</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">getEventListeners</span><span class="hl-1">, </span><span class="hl-3">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">listener</span><span class="hl-1"> = () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-0">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">getEventListeners</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-1">}</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">et</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">listener</span><span class="hl-1"> = () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">et</span><span class="hl-1">.</span><span class="hl-4">addEventListener</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-0">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">getEventListeners</span><span class="hl-1">(</span><span class="hl-0">et</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-1">}</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v15.2.0, v14.17.0</p>
|
||||
@@ -2230,7 +2230,7 @@ event target. This is useful for debugging and diagnostic purposes.</p>
|
||||
<li class="tsd-signature tsd-anchor-link" id="listenerCount-2.listenerCount-3">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount-2.listenerCount-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">listenerCount</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-3">listenerCount</span><span class="hl-1">(</span><span class="hl-4">myEmitter</span><span class="hl-1">, </span><span class="hl-7">'event'</span><span class="hl-1">));</span><br/><span class="hl-5">// Prints: 2</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">EventEmitter</span><span class="hl-1">, </span><span class="hl-3">listenerCount</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEmitter</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">listenerCount</span><span class="hl-1">(</span><span class="hl-0">myEmitter</span><span class="hl-1">, </span><span class="hl-5">'event'</span><span class="hl-1">));</span><br/><span class="hl-7">// Prints: 2</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.9.12</p>
|
||||
@@ -2257,14 +2257,14 @@ event target. This is useful for debugging and diagnostic purposes.</p>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
<li class="tsd-signature tsd-anchor-link" id="on-10.on-11">on<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#on-10.on-11" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">on</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">(</span><span class="hl-0">async</span><span class="hl-1"> () </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-7">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">for</span><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">event</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-5">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-5">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-5">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">event</span><span class="hl-1">); </span><span class="hl-5">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-5">// Unreachable here</span><br/><span class="hl-1">})();</span>
|
||||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">on</span><span class="hl-1">, </span><span class="hl-3">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">(</span><span class="hl-2">async</span><span class="hl-1"> () </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-5">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">for</span><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> (</span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">event</span><span class="hl-1"> </span><span class="hl-2">of</span><span class="hl-1"> </span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-1">})();</span>
|
||||
</code></pre>
|
||||
<p>Returns an <code>AsyncIterator</code> that iterates <code>eventName</code> events. It will throw
|
||||
if the <code>EventEmitter</code> emits <code>'error'</code>. It removes all listeners when
|
||||
exiting the loop. The <code>value</code> returned by each iteration is an array
|
||||
composed of the emitted event arguments.</p>
|
||||
<p>An <code>AbortSignal</code> can be used to cancel waiting on events:</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">on</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ac</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-1">(</span><span class="hl-0">async</span><span class="hl-1"> () </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-7">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">for</span><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">event</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">, { </span><span class="hl-4">signal:</span><span class="hl-1"> </span><span class="hl-4">ac</span><span class="hl-1">.</span><span class="hl-4">signal</span><span class="hl-1"> })) {</span><br/><span class="hl-1"> </span><span class="hl-5">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-5">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-5">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">event</span><span class="hl-1">); </span><span class="hl-5">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-5">// Unreachable here</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">ac</span><span class="hl-1">.</span><span class="hl-3">abort</span><span class="hl-1">());</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">on</span><span class="hl-1">, </span><span class="hl-3">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ac</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-1">(</span><span class="hl-2">async</span><span class="hl-1"> () </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-5">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">for</span><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> (</span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">event</span><span class="hl-1"> </span><span class="hl-2">of</span><span class="hl-1"> </span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">, { </span><span class="hl-0">signal:</span><span class="hl-1"> </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-0">signal</span><span class="hl-1"> })) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-4">abort</span><span class="hl-1">());</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v13.6.0, v12.16.0</p>
|
||||
@@ -2297,15 +2297,15 @@ The <code>Promise</code> will resolve with an array of all the arguments emitted
|
||||
given event.</p>
|
||||
<p>This method is intentionally generic and works with the web platform <a href="https://dom.spec.whatwg.org/#interface-eventtarget">EventTarget</a> interface, which has no special<code>'error'</code> event
|
||||
semantics and does not listen to the <code>'error'</code> event.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">once</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'myevent'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> [</span><span class="hl-2">value</span><span class="hl-1">] = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">value</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">err</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-8">Error</span><span class="hl-1">(</span><span class="hl-7">'kaboom'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'error'</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-4">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'error happened'</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">run</span><span class="hl-1">();</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">once</span><span class="hl-1">, </span><span class="hl-3">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-2">async</span><span class="hl-1"> </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">run</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'myevent'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> [</span><span class="hl-3">value</span><span class="hl-1">] = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">value</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">err</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Error</span><span class="hl-1">(</span><span class="hl-5">'kaboom'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'error'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-0">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'error happened'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">run</span><span class="hl-1">();</span>
|
||||
</code></pre>
|
||||
<p>The special handling of the <code>'error'</code> event is only used when <code>events.once()</code>is used to wait for another event. If <code>events.once()</code> is used to wait for the
|
||||
'<code>error'</code> event itself, then it is treated as any other kind of event without
|
||||
special handling:</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">once</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'error'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-3">then</span><span class="hl-1">(([</span><span class="hl-4">err</span><span class="hl-1">]) </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'ok'</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">.</span><span class="hl-4">message</span><span class="hl-1">))</span><br/><span class="hl-1"> .</span><span class="hl-3">catch</span><span class="hl-1">((</span><span class="hl-4">err</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'error'</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">.</span><span class="hl-4">message</span><span class="hl-1">));</span><br/><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'error'</span><span class="hl-1">, </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-8">Error</span><span class="hl-1">(</span><span class="hl-7">'boom'</span><span class="hl-1">));</span><br/><br/><span class="hl-5">// Prints: ok boom</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">EventEmitter</span><span class="hl-1">, </span><span class="hl-3">once</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'error'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-4">then</span><span class="hl-1">(([</span><span class="hl-0">err</span><span class="hl-1">]) </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'ok'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">))</span><br/><span class="hl-1"> .</span><span class="hl-4">catch</span><span class="hl-1">((</span><span class="hl-0">err</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'error'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">));</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'error'</span><span class="hl-1">, </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Error</span><span class="hl-1">(</span><span class="hl-5">'boom'</span><span class="hl-1">));</span><br/><br/><span class="hl-7">// Prints: ok boom</span>
|
||||
</code></pre>
|
||||
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">once</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ac</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">foo</span><span class="hl-1">(</span><span class="hl-4">emitter</span><span class="hl-1">, </span><span class="hl-4">event</span><span class="hl-1">, </span><span class="hl-4">signal</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">emitter</span><span class="hl-1">, </span><span class="hl-4">event</span><span class="hl-1">, { </span><span class="hl-4">signal</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'event emitted!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-4">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1"> (</span><span class="hl-4">error</span><span class="hl-1">.</span><span class="hl-4">name</span><span class="hl-1"> === </span><span class="hl-7">'AbortError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">error</span><span class="hl-1">(</span><span class="hl-7">'Waiting for the event was canceled!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">error</span><span class="hl-1">(</span><span class="hl-7">'There was an error'</span><span class="hl-1">, </span><span class="hl-4">error</span><span class="hl-1">.</span><span class="hl-4">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">foo</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-4">ac</span><span class="hl-1">.</span><span class="hl-4">signal</span><span class="hl-1">);</span><br/><span class="hl-4">ac</span><span class="hl-1">.</span><span class="hl-3">abort</span><span class="hl-1">(); </span><span class="hl-5">// Abort waiting for the event</span><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">); </span><span class="hl-5">// Prints: Waiting for the event was canceled!</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">EventEmitter</span><span class="hl-1">, </span><span class="hl-3">once</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ac</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-2">async</span><span class="hl-1"> </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">foo</span><span class="hl-1">(</span><span class="hl-0">emitter</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">, </span><span class="hl-0">signal</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-0">emitter</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">, { </span><span class="hl-0">signal</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'event emitted!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-5">'AbortError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">error</span><span class="hl-1">(</span><span class="hl-5">'Waiting for the event was canceled!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">error</span><span class="hl-1">(</span><span class="hl-5">'There was an error'</span><span class="hl-1">, </span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">foo</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-0">signal</span><span class="hl-1">);</span><br/><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-4">abort</span><span class="hl-1">(); </span><span class="hl-7">// Abort waiting for the event</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">); </span><span class="hl-7">// Prints: Waiting for the event was canceled!</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v11.13.0, v10.16.0</p>
|
||||
@@ -2348,7 +2348,7 @@ added for a particular event. This is a useful default that helps finding
|
||||
memory leaks. The <code>EventEmitter.setMaxListeners()</code> method allows the default limit to be
|
||||
modified (if eventTargets is empty) or modify the limit specified in every <code>EventTarget</code> | <code>EventEmitter</code> passed as arguments.
|
||||
The value can be set to<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">EventEmitter</span><span class="hl-1">.</span><span class="hl-3">setMaxListeners</span><span class="hl-1">(</span><span class="hl-9">20</span><span class="hl-1">);</span><br/><span class="hl-5">// Equivalent to</span><br/><span class="hl-4">EventEmitter</span><span class="hl-1">.</span><span class="hl-4">defaultMaxListeners</span><span class="hl-1"> = </span><span class="hl-9">20</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">eventTarget</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-5">// Only way to increase limit for `EventTarget` instances</span><br/><span class="hl-5">// as these doesn't expose its own `setMaxListeners` method</span><br/><span class="hl-4">EventEmitter</span><span class="hl-1">.</span><span class="hl-3">setMaxListeners</span><span class="hl-1">(</span><span class="hl-9">20</span><span class="hl-1">, </span><span class="hl-4">eventTarget</span><span class="hl-1">);</span>
|
||||
<pre><code class="language-js"><span class="hl-0">EventEmitter</span><span class="hl-1">.</span><span class="hl-4">setMaxListeners</span><span class="hl-1">(</span><span class="hl-9">20</span><span class="hl-1">);</span><br/><span class="hl-7">// Equivalent to</span><br/><span class="hl-0">EventEmitter</span><span class="hl-1">.</span><span class="hl-0">defaultMaxListeners</span><span class="hl-1"> = </span><span class="hl-9">20</span><span class="hl-1">;</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">eventTarget</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-7">// Only way to increase limit for `EventTarget` instances</span><br/><span class="hl-7">// as these doesn't expose its own `setMaxListeners` method</span><br/><span class="hl-0">EventEmitter</span><span class="hl-1">.</span><span class="hl-4">setMaxListeners</span><span class="hl-1">(</span><span class="hl-9">20</span><span class="hl-1">, </span><span class="hl-0">eventTarget</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v15.3.0, v14.17.0</p>
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L180">packages/xrpl/src/client/index.ts:180</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L180">packages/xrpl/src/client/index.ts:180</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">
|
||||
@@ -119,18 +119,18 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.constructor</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L210">packages/xrpl/src/client/index.ts:210</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L210">packages/xrpl/src/client/index.ts:210</a></li></ul></aside></li></ul></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Abstraction</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="getBalances" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>get<wbr/>Balances</span><a href="#getBalances" 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">get<wbr/>Balances<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getBalances</span></div>
|
||||
<div class="tsd-signature">get<wbr/>Balances<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getBalances</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-4.__type-5"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-4.__type-5"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Get XRP/non-XRP balances for an account.</p>
|
||||
|
||||
@@ -148,7 +148,7 @@
|
||||
<div class="tsd-comment tsd-typography"><p>Address of the account to retrieve balances for.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Allows the client to specify a ledger_hash, ledger_index,
|
||||
filter by peer, and/or limit number of balances.</p>
|
||||
</div>
|
||||
@@ -171,9 +171,9 @@ ledger_index.</p>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Filter balances by peer.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L620">packages/xrpl/src/client/index.ts:620</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L620">packages/xrpl/src/client/index.ts:620</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="getLedgerIndex" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>get<wbr/>Ledger<wbr/>Index</span><a href="#getLedgerIndex" 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">get<wbr/>Ledger<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getLedgerIndex</span></div>
|
||||
@@ -197,16 +197,16 @@ ledger_index.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L630">packages/xrpl/src/client/index.ts:630</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L630">packages/xrpl/src/client/index.ts:630</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="getOrderbook" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>get<wbr/>Orderbook</span><a href="#getOrderbook" 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">get<wbr/>Orderbook<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getOrderbook</span></div>
|
||||
<div class="tsd-signature">get<wbr/>Orderbook<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getOrderbook</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-8.__type-9"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-8.__type-9"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Fetch orderbook (buy/sell orders) between two accounts.</p>
|
||||
|
||||
@@ -230,7 +230,7 @@ offer would pay, as an object with <code>currency</code> and <code>issuer</code>
|
||||
offer would receive, as an object with <code>currency</code> and <code>issuer</code> fields.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Options allowing the client to specify ledger_index,
|
||||
ledger_hash, filter by taker, and/or limit number of orders.</p>
|
||||
</div>
|
||||
@@ -253,22 +253,22 @@ the order book. Defaults to 20.</p>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Filter orders by taker.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L625">packages/xrpl/src/client/index.ts:625</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L625">packages/xrpl/src/client/index.ts:625</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="getXrpBalance" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>get<wbr/>Xrp<wbr/>Balance</span><a href="#getXrpBalance" 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">get<wbr/>Xrp<wbr/>Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getXrpBalance</span></div>
|
||||
<div class="tsd-signature">get<wbr/>Xrp<wbr/>Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getXrpBalance</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-10.__type-11"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-10.__type-11"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Get the XRP balance for an account.</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Client</span><span class="hl-1">(</span><span class="hl-4">wss</span><span class="hl-1">:</span><span class="hl-5">//s.altnet.rippletest.net:51233)</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-4">balance</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-3">getXrpBalance</span><span class="hl-1">(</span><span class="hl-7">'rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn'</span><span class="hl-1">)</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">balance</span><span class="hl-1">)</span><br/><span class="hl-5">/// '200'</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-0">wss</span><span class="hl-1">:</span><span class="hl-7">//s.altnet.rippletest.net:51233)</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-0">balance</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">getXrpBalance</span><span class="hl-1">(</span><span class="hl-5">'rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn'</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">balance</span><span class="hl-1">)</span><br/><span class="hl-7">/// '200'</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Returns</h3><p>The XRP balance of the account (as a string).</p>
|
||||
@@ -285,7 +285,7 @@ the order book. Defaults to 20.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>Address of the account to retrieve XRP balance.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Options to include for getting the XRP balance.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -301,7 +301,7 @@ ledger_index.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L615">packages/xrpl/src/client/index.ts:615</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L615">packages/xrpl/src/client/index.ts:615</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Core</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="autofill" class="tsd-anchor"></a>
|
||||
@@ -321,11 +321,11 @@ flags interfaces into numbers.</p>
|
||||
|
||||
<h3>Returns</h3><p>The autofilled transaction.</p>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
<h4 class="tsd-type-parameters-title">Type Parameters</h4>
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h4>Type Parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></div>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></section>
|
||||
<div class="tsd-parameters">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameter-list">
|
||||
@@ -344,16 +344,16 @@ Only used for multisigned transactions.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L596">packages/xrpl/src/client/index.ts:596</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L596">packages/xrpl/src/client/index.ts:596</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="submit" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>submit</span><a href="#submit" 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">submit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submit</span></div>
|
||||
<div class="tsd-signature">submit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submit</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-14.__type-15"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-14.__type-15"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Submits a signed/unsigned transaction.
|
||||
Steps performed on a transaction:</p>
|
||||
@@ -379,7 +379,7 @@ Steps performed on a transaction:</p>
|
||||
<div class="tsd-comment tsd-typography"><p>A transaction to autofill, sign & encode, and submit.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options used to sign and submit a transaction.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -397,16 +397,16 @@ Steps performed on a transaction:</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L601">packages/xrpl/src/client/index.ts:601</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L601">packages/xrpl/src/client/index.ts:601</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="submitAndWait" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>submit<wbr/>And<wbr/>Wait</span><a href="#submitAndWait" 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">submit<wbr/>And<wbr/>Wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submitAndWait</span></div>
|
||||
<div class="tsd-signature">submit<wbr/>And<wbr/>Wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submitAndWait</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-16.__type-17"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-16.__type-17"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Asynchronously submits a transaction and verifies that it has been included in a
|
||||
validated ledger (or has errored/will not be included for some reason).
|
||||
@@ -426,7 +426,7 @@ See <a href="https://xrpl.org/reliable-transaction-submission.html">Reliable Tra
|
||||
<div class="tsd-comment tsd-typography"><p>A transaction to autofill, sign & encode, and submit.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options used to sign and submit a transaction.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -444,22 +444,22 @@ See <a href="https://xrpl.org/reliable-transaction-submission.html">Reliable Tra
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L605">packages/xrpl/src/client/index.ts:605</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L605">packages/xrpl/src/client/index.ts:605</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Faucet</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="fundWallet" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>fund<wbr/>Wallet</span><a href="#fundWallet" 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">fund<wbr/>Wallet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = fundWallet</span></div>
|
||||
<div class="tsd-signature">fund<wbr/>Wallet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = fundWallet</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type-2.__type-3"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature" id="__type-2.__type-3"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Generates a random wallet with some amount of XRP (usually 1000 XRP).</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-typescript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">api</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-4">xrpl</span><span class="hl-1">.</span><span class="hl-3">Client</span><span class="hl-1">(</span><span class="hl-7">"wss://s.altnet.rippletest.net:51233"</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">connect</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">wallet</span><span class="hl-1">, </span><span class="hl-2">balance</span><span class="hl-1"> } = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">fundWallet</span><span class="hl-1">()</span>
|
||||
<h3>Example</h3><pre><code class="language-typescript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">api</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-0">xrpl</span><span class="hl-1">.</span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">"wss://s.altnet.rippletest.net:51233"</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">wallet</span><span class="hl-1">, </span><span class="hl-3">balance</span><span class="hl-1"> } = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">fundWallet</span><span class="hl-1">()</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Returns</h3><p>A Wallet on the Testnet or Devnet that contains some amount of XRP,
|
||||
@@ -479,7 +479,7 @@ and that wallet's balance in XRP.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-symbol">{ </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>See below.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -491,9 +491,9 @@ automatically. In other environments, or if you would like to customize the
|
||||
faucet host in devnet or testnet, you should provide the host using this
|
||||
option.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L635">packages/xrpl/src/client/index.ts:635</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L635">packages/xrpl/src/client/index.ts:635</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Fee</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="feeCushion" class="tsd-anchor"></a>
|
||||
@@ -503,7 +503,7 @@ option.</p>
|
||||
required fee rises during submission of a transaction. Defaults to 1.2.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L192">packages/xrpl/src/client/index.ts:192</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L192">packages/xrpl/src/client/index.ts:192</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="maxFeeXRP" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>max<wbr/>FeeXRP</span><a href="#maxFeeXRP" 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">max<wbr/>FeeXRP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
@@ -511,7 +511,7 @@ required fee rises during submission of a transaction. Defaults to 1.2.</p>
|
||||
number. Defaults to '2'.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L200">packages/xrpl/src/client/index.ts:200</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L200">packages/xrpl/src/client/index.ts:200</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Network</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="url" class="tsd-anchor"></a>
|
||||
@@ -525,7 +525,7 @@ number. Defaults to '2'.</p>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L280">packages/xrpl/src/client/index.ts:280</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L280">packages/xrpl/src/client/index.ts:280</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="connect" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -537,7 +537,7 @@ number. Defaults to '2'.</p>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L565">packages/xrpl/src/client/index.ts:565</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L565">packages/xrpl/src/client/index.ts:565</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="disconnect" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>disconnect</span><a href="#disconnect" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -549,7 +549,7 @@ number. Defaults to '2'.</p>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L575">packages/xrpl/src/client/index.ts:575</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L575">packages/xrpl/src/client/index.ts:575</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isConnected" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>is<wbr/>Connected</span><a href="#isConnected" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -561,7 +561,7 @@ number. Defaults to '2'.</p>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L589">packages/xrpl/src/client/index.ts:589</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L589">packages/xrpl/src/client/index.ts:589</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="on" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -569,7 +569,7 @@ number. Defaults to '2'.</p>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">api</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Client</span><span class="hl-1">(</span><span class="hl-7">'wss://s.altnet.rippletest.net:51233'</span><span class="hl-1">)</span><br/><br/><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'transactions'</span><span class="hl-1">, (</span><span class="hl-4">tx</span><span class="hl-1">: </span><span class="hl-8">TransactionStream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">"Received Transaction"</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">tx</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">connect</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">response</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-3">request</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">command:</span><span class="hl-1"> </span><span class="hl-7">'subscribe'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">streams:</span><span class="hl-1"> [</span><span class="hl-7">'transactions_proposed'</span><span class="hl-1">]</span><br/><span class="hl-1">})</span>
|
||||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">api</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">'wss://s.altnet.rippletest.net:51233'</span><span class="hl-1">)</span><br/><br/><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'transactions'</span><span class="hl-1">, (</span><span class="hl-0">tx</span><span class="hl-1">: </span><span class="hl-8">TransactionStream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">"Received Transaction"</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">tx</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">response</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">request</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">'subscribe'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">streams:</span><span class="hl-1"> [</span><span class="hl-5">'transactions_proposed'</span><span class="hl-1">]</span><br/><span class="hl-1">})</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<div class="tsd-parameters">
|
||||
@@ -588,7 +588,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L435">packages/xrpl/src/client/index.ts:435</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L435">packages/xrpl/src/client/index.ts:435</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-2">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"disconnected"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#on.on-2" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -618,7 +618,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L436">packages/xrpl/src/client/index.ts:436</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L436">packages/xrpl/src/client/index.ts:436</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-3">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ledgerClosed"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>ledger<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerStream.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#on.on-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -648,7 +648,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L437">packages/xrpl/src/client/index.ts:437</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L437">packages/xrpl/src/client/index.ts:437</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-4">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"validationReceived"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>validation<span class="tsd-signature-symbol">: </span><a href="../interfaces/ValidationStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#on.on-4" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -678,7 +678,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L441">packages/xrpl/src/client/index.ts:441</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L441">packages/xrpl/src/client/index.ts:441</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-5">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"transaction"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../interfaces/TransactionStream.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#on.on-5" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -708,7 +708,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L445">packages/xrpl/src/client/index.ts:445</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L445">packages/xrpl/src/client/index.ts:445</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-6">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"peerStatusChange"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">: </span><a href="../interfaces/PeerStatusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerStatusStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#on.on-6" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -738,7 +738,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L449">packages/xrpl/src/client/index.ts:449</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L449">packages/xrpl/src/client/index.ts:449</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-7">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"consensusPhase"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>phase<span class="tsd-signature-symbol">: </span><a href="../interfaces/ConsensusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ConsensusStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#on.on-7" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -768,7 +768,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L453">packages/xrpl/src/client/index.ts:453</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L453">packages/xrpl/src/client/index.ts:453</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-8">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"path_find"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><a href="../interfaces/PathFindStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#on.on-8" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -798,7 +798,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L457">packages/xrpl/src/client/index.ts:457</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L457">packages/xrpl/src/client/index.ts:457</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="on.on-9">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#on.on-9" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||||
@@ -828,7 +828,7 @@ number. Defaults to '2'.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.on</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L459">packages/xrpl/src/client/index.ts:459</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L459">packages/xrpl/src/client/index.ts:459</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="request" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>request</span><a href="#request" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -841,7 +841,7 @@ number. Defaults to '2'.</p>
|
||||
<h5>r: <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L287">packages/xrpl/src/client/index.ts:287</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L287">packages/xrpl/src/client/index.ts:287</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-2">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountCurrenciesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-2" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -856,7 +856,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/AccountCurrenciesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L290">packages/xrpl/src/client/index.ts:290</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L290">packages/xrpl/src/client/index.ts:290</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-3">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -871,7 +871,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/AccountInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L293">packages/xrpl/src/client/index.ts:293</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L293">packages/xrpl/src/client/index.ts:293</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-4">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-4" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -886,7 +886,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L294">packages/xrpl/src/client/index.ts:294</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L294">packages/xrpl/src/client/index.ts:294</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-5">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountNFTsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-5" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -901,7 +901,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/AccountNFTsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L295">packages/xrpl/src/client/index.ts:295</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L295">packages/xrpl/src/client/index.ts:295</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-6">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-6" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -916,7 +916,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L296">packages/xrpl/src/client/index.ts:296</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L296">packages/xrpl/src/client/index.ts:296</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-7">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-7" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -931,7 +931,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L299">packages/xrpl/src/client/index.ts:299</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L299">packages/xrpl/src/client/index.ts:299</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-8">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-8" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -946,7 +946,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L300">packages/xrpl/src/client/index.ts:300</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L300">packages/xrpl/src/client/index.ts:300</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-9">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-9" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -961,7 +961,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L301">packages/xrpl/src/client/index.ts:301</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L301">packages/xrpl/src/client/index.ts:301</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-10">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ChannelVerifyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-10" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -976,7 +976,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/ChannelVerifyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L302">packages/xrpl/src/client/index.ts:302</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L302">packages/xrpl/src/client/index.ts:302</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-11">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/DepositAuthorizedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-11" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -991,7 +991,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/DepositAuthorizedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L303">packages/xrpl/src/client/index.ts:303</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L303">packages/xrpl/src/client/index.ts:303</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-12">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/FeeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-12" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1006,7 +1006,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/FeeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L306">packages/xrpl/src/client/index.ts:306</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L306">packages/xrpl/src/client/index.ts:306</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-13">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/GatewayBalancesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-13" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1021,7 +1021,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/GatewayBalancesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-14">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-14" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1036,7 +1036,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/LedgerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L310">packages/xrpl/src/client/index.ts:310</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L310">packages/xrpl/src/client/index.ts:310</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-15">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerClosedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-15" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1051,7 +1051,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/LedgerClosedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L311">packages/xrpl/src/client/index.ts:311</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L311">packages/xrpl/src/client/index.ts:311</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-16">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerCurrentRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-16" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1066,7 +1066,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/LedgerCurrentRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L312">packages/xrpl/src/client/index.ts:312</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L312">packages/xrpl/src/client/index.ts:312</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-17">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-17" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1081,7 +1081,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L313">packages/xrpl/src/client/index.ts:313</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L313">packages/xrpl/src/client/index.ts:313</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-18">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-18" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1096,7 +1096,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/LedgerEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L314">packages/xrpl/src/client/index.ts:314</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L314">packages/xrpl/src/client/index.ts:314</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-19">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ManifestRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-19" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1111,7 +1111,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/ManifestRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L315">packages/xrpl/src/client/index.ts:315</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L315">packages/xrpl/src/client/index.ts:315</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-20">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NFTBuyOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTBuyOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-20" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1126,7 +1126,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/NFTBuyOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTBuyOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L316">packages/xrpl/src/client/index.ts:316</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L316">packages/xrpl/src/client/index.ts:316</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-21">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NFTSellOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTSellOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-21" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1141,7 +1141,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/NFTSellOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTSellOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L317">packages/xrpl/src/client/index.ts:317</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L317">packages/xrpl/src/client/index.ts:317</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-22">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NoRippleCheckRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-22" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1156,7 +1156,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/NoRippleCheckRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L318">packages/xrpl/src/client/index.ts:318</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L318">packages/xrpl/src/client/index.ts:318</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-23">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../types/PathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Type alias">PathFindRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-23" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1171,7 +1171,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../types/PathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Type alias">PathFindRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L319">packages/xrpl/src/client/index.ts:319</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L319">packages/xrpl/src/client/index.ts:319</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-24">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/PingRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PingRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-24" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1186,7 +1186,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/PingRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PingRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L320">packages/xrpl/src/client/index.ts:320</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L320">packages/xrpl/src/client/index.ts:320</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-25">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/RandomRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-25" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1201,7 +1201,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/RandomRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L321">packages/xrpl/src/client/index.ts:321</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L321">packages/xrpl/src/client/index.ts:321</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-26">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/RipplePathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-26" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1216,7 +1216,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/RipplePathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L322">packages/xrpl/src/client/index.ts:322</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L322">packages/xrpl/src/client/index.ts:322</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-27">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServerInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-27" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1231,7 +1231,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/ServerInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L325">packages/xrpl/src/client/index.ts:325</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L325">packages/xrpl/src/client/index.ts:325</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-28">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServerStateRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-28" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1246,7 +1246,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/ServerStateRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L326">packages/xrpl/src/client/index.ts:326</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L326">packages/xrpl/src/client/index.ts:326</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-29">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubmitRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-29" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1261,7 +1261,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/SubmitRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L327">packages/xrpl/src/client/index.ts:327</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L327">packages/xrpl/src/client/index.ts:327</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-30">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubmitMultisignedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-30" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1276,7 +1276,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/SubmitMultisignedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L328">packages/xrpl/src/client/index.ts:328</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L328">packages/xrpl/src/client/index.ts:328</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-31">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-31" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1291,7 +1291,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/SubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L331">packages/xrpl/src/client/index.ts:331</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L331">packages/xrpl/src/client/index.ts:331</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-32">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/UnsubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-32" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1306,7 +1306,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/UnsubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L332">packages/xrpl/src/client/index.ts:332</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L332">packages/xrpl/src/client/index.ts:332</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-33">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/TransactionEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-33" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1321,7 +1321,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/TransactionEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L333">packages/xrpl/src/client/index.ts:333</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L333">packages/xrpl/src/client/index.ts:333</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-34">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/TxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-34" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1336,7 +1336,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <a href="../interfaces/TxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TxRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L336">packages/xrpl/src/client/index.ts:336</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L336">packages/xrpl/src/client/index.ts:336</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="request.request-35">request<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><a href="#request.request-35" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||||
@@ -1344,13 +1344,13 @@ additional request body parameters.</p>
|
||||
|
||||
<h3>Returns</h3><p>The response from the server.</p>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
<h4 class="tsd-type-parameters-title">Type Parameters</h4>
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h4>Type Parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>R<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">BaseRequest</span></h4></li>
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">BaseResponse</span></h4></li></ul></div>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">BaseResponse</span></h4></li></ul></section>
|
||||
<div class="tsd-parameters">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameter-list">
|
||||
@@ -1358,7 +1358,7 @@ additional request body parameters.</p>
|
||||
<h5>r: <span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L337">packages/xrpl/src/client/index.ts:337</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L337">packages/xrpl/src/client/index.ts:337</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="requestAll" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>request<wbr/>All</span><a href="#requestAll" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -1371,7 +1371,7 @@ additional request body parameters.</p>
|
||||
<h5>req: <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L475">packages/xrpl/src/client/index.ts:475</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L475">packages/xrpl/src/client/index.ts:475</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-2">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-2" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1395,7 +1395,7 @@ requests as needed.</p>
|
||||
<h5>req: <a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L478">packages/xrpl/src/client/index.ts:478</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L478">packages/xrpl/src/client/index.ts:478</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-3">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1419,7 +1419,7 @@ requests as needed.</p>
|
||||
<h5>req: <a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L481">packages/xrpl/src/client/index.ts:481</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L481">packages/xrpl/src/client/index.ts:481</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-4">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-4" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1443,7 +1443,7 @@ requests as needed.</p>
|
||||
<h5>req: <a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L484">packages/xrpl/src/client/index.ts:484</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L484">packages/xrpl/src/client/index.ts:484</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-5">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-5" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1467,7 +1467,7 @@ requests as needed.</p>
|
||||
<h5>req: <a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L487">packages/xrpl/src/client/index.ts:487</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L487">packages/xrpl/src/client/index.ts:487</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-6">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-6" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1491,7 +1491,7 @@ requests as needed.</p>
|
||||
<h5>req: <a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L488">packages/xrpl/src/client/index.ts:488</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L488">packages/xrpl/src/client/index.ts:488</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-7">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-7" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||||
@@ -1515,7 +1515,7 @@ requests as needed.</p>
|
||||
<h5>req: <a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="requestNextPage" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>request<wbr/>Next<wbr/>Page</span><a href="#requestNextPage" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -1530,7 +1530,7 @@ requests as needed.</p>
|
||||
<h5>resp: <a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L369">packages/xrpl/src/client/index.ts:369</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L369">packages/xrpl/src/client/index.ts:369</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-2">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-2" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1550,7 +1550,7 @@ requests as needed.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L373">packages/xrpl/src/client/index.ts:373</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L373">packages/xrpl/src/client/index.ts:373</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-3">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1570,7 +1570,7 @@ requests as needed.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L377">packages/xrpl/src/client/index.ts:377</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L377">packages/xrpl/src/client/index.ts:377</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-4">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-4" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1590,7 +1590,7 @@ requests as needed.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L381">packages/xrpl/src/client/index.ts:381</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L381">packages/xrpl/src/client/index.ts:381</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-5">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-5" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1610,7 +1610,7 @@ requests as needed.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L385">packages/xrpl/src/client/index.ts:385</a></li></ul></aside></li>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L385">packages/xrpl/src/client/index.ts:385</a></li></ul></aside></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-6">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-6" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||||
@@ -1630,14 +1630,14 @@ requests as needed.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L389">packages/xrpl/src/client/index.ts:389</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L389">packages/xrpl/src/client/index.ts:389</a></li></ul></aside></li></ul></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||||
<h2>Other</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="connection" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>connection</span><a href="#connection" 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">connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Connection</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L184">packages/xrpl/src/client/index.ts:184</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L184">packages/xrpl/src/client/index.ts:184</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="prepareTransaction" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>prepare<wbr/>Transaction</span><a href="#prepareTransaction" 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">prepare<wbr/>Transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, signersCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = autofill</span></div>
|
||||
@@ -1655,11 +1655,11 @@ flags interfaces into numbers.</p>
|
||||
|
||||
<h3>Returns</h3><p>The autofilled transaction.</p>
|
||||
</div>
|
||||
<div class="tsd-type-parameters">
|
||||
<h4 class="tsd-type-parameters-title">Type Parameters</h4>
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h4>Type Parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></div>
|
||||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></section>
|
||||
<div class="tsd-parameters">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameter-list">
|
||||
@@ -1678,7 +1678,7 @@ Only used for multisigned transactions.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/client/index.ts#L610">packages/xrpl/src/client/index.ts:610</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/client/index.ts#L610">packages/xrpl/src/client/index.ts:610</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" 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">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="BroadcastClient.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources">
|
||||
@@ -1751,7 +1751,7 @@ regular <code>'error'</code> listener is installed.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>Synchronously calls each of the listeners registered for the event named<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
||||
to each.</p>
|
||||
<p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">EventEmitter</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// First listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">firstListener</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Helloooo! first listener'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Second listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">secondListener</span><span class="hl-1">(</span><span class="hl-4">arg1</span><span class="hl-1">, </span><span class="hl-4">arg2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">`event with parameters </span><span class="hl-0">${</span><span class="hl-4">arg1</span><span class="hl-0">}</span><span class="hl-7">, </span><span class="hl-0">${</span><span class="hl-4">arg2</span><span class="hl-0">}</span><span class="hl-7"> in second listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Third listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">thirdListener</span><span class="hl-1">(...</span><span class="hl-4">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">parameters</span><span class="hl-1"> = </span><span class="hl-4">args</span><span class="hl-1">.</span><span class="hl-3">join</span><span class="hl-1">(</span><span class="hl-7">', '</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">`event with parameters </span><span class="hl-0">${</span><span class="hl-4">parameters</span><span class="hl-0">}</span><span class="hl-7"> in third listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">listeners</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">));</span><br/><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-9">1</span><span class="hl-1">, </span><span class="hl-9">2</span><span class="hl-1">, </span><span class="hl-9">3</span><span class="hl-1">, </span><span class="hl-9">4</span><span class="hl-1">, </span><span class="hl-9">5</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// [</span><br/><span class="hl-5">// [Function: firstListener],</span><br/><span class="hl-5">// [Function: secondListener],</span><br/><span class="hl-5">// [Function: thirdListener]</span><br/><span class="hl-5">// ]</span><br/><span class="hl-5">// Helloooo! first listener</span><br/><span class="hl-5">// event with parameters 1, 2 in second listener</span><br/><span class="hl-5">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1"> = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEmitter</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// First listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">firstListener</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Helloooo! first listener'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-7">// Second listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">secondListener</span><span class="hl-1">(</span><span class="hl-0">arg1</span><span class="hl-1">, </span><span class="hl-0">arg2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">`event with parameters </span><span class="hl-2">${</span><span class="hl-0">arg1</span><span class="hl-2">}</span><span class="hl-5">, </span><span class="hl-2">${</span><span class="hl-0">arg2</span><span class="hl-2">}</span><span class="hl-5"> in second listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-7">// Third listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">thirdListener</span><span class="hl-1">(...</span><span class="hl-0">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">parameters</span><span class="hl-1"> = </span><span class="hl-0">args</span><span class="hl-1">.</span><span class="hl-4">join</span><span class="hl-1">(</span><span class="hl-5">', '</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">`event with parameters </span><span class="hl-2">${</span><span class="hl-0">parameters</span><span class="hl-2">}</span><span class="hl-5"> in third listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">listeners</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">));</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-9">1</span><span class="hl-1">, </span><span class="hl-9">2</span><span class="hl-1">, </span><span class="hl-9">3</span><span class="hl-1">, </span><span class="hl-9">4</span><span class="hl-1">, </span><span class="hl-9">5</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// [</span><br/><span class="hl-7">// [Function: firstListener],</span><br/><span class="hl-7">// [Function: secondListener],</span><br/><span class="hl-7">// [Function: thirdListener]</span><br/><span class="hl-7">// ]</span><br/><span class="hl-7">// Helloooo! first listener</span><br/><span class="hl-7">// event with parameters 1, 2 in second listener</span><br/><span class="hl-7">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.1.26</p>
|
||||
@@ -1774,7 +1774,7 @@ to each.</p>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns an array listing the events for which the emitter has registered
|
||||
listeners. The values in the array are strings or <code>Symbol</code>s.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">EventEmitter</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEE</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'bar'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">sym</span><span class="hl-1"> = </span><span class="hl-8">Symbol</span><span class="hl-1">(</span><span class="hl-7">'symbol'</span><span class="hl-1">);</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">sym</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">eventNames</span><span class="hl-1">());</span><br/><span class="hl-5">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1"> = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEE</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'bar'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">sym</span><span class="hl-1"> = </span><span class="hl-4">Symbol</span><span class="hl-1">(</span><span class="hl-5">'symbol'</span><span class="hl-1">);</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-0">sym</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">eventNames</span><span class="hl-1">());</span><br/><span class="hl-7">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v6.0.0</p>
|
||||
@@ -1823,7 +1823,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="Client.ht
|
||||
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1">listeners<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">util</span><span class="hl-1">.</span><span class="hl-3">inspect</span><span class="hl-1">(</span><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">listeners</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">)));</span><br/><span class="hl-5">// Prints: [ [Function] ]</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">util</span><span class="hl-1">.</span><span class="hl-4">inspect</span><span class="hl-1">(</span><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">listeners</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">)));</span><br/><span class="hl-7">// Prints: [ [Function] ]</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.1.26</p>
|
||||
@@ -1875,12 +1875,12 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="Client.ht
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code>. The
|
||||
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
|
||||
event listener to the beginning of the listeners array.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEE</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'a'</span><span class="hl-1">));</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">prependOnceListener</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'b'</span><span class="hl-1">));</span><br/><span class="hl-4">myEE</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// b</span><br/><span class="hl-5">// a</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEE</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'a'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">prependOnceListener</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'b'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// b</span><br/><span class="hl-7">// a</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.3.0</p>
|
||||
@@ -1920,7 +1920,7 @@ event listener to the beginning of the listeners array.</p>
|
||||
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
||||
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
||||
times.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">prependListener</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">prependListener</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
@@ -1959,7 +1959,7 @@ times.</p>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code> to the_beginning_ of the listeners array. The next time <code>eventName</code> is triggered, this
|
||||
listener is removed, and then invoked.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">prependOnceListener</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">prependOnceListener</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
@@ -1998,7 +1998,7 @@ listener is removed, and then invoked.</p>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
||||
including any wrappers (such as those created by <code>.once()</code>).</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'log once'</span><span class="hl-1">));</span><br/><br/><span class="hl-5">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-5">// `listener` which contains the original listener bound above</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">listeners</span><span class="hl-1"> = </span><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">rawListeners</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">logFnWrapper</span><span class="hl-1"> = </span><span class="hl-4">listeners</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">];</span><br/><br/><span class="hl-5">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-4">logFnWrapper</span><span class="hl-1">.</span><span class="hl-3">listener</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-3">logFnWrapper</span><span class="hl-1">();</span><br/><br/><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'log persistently'</span><span class="hl-1">));</span><br/><span class="hl-5">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">newListeners</span><span class="hl-1"> = </span><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">rawListeners</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Logs "log persistently" twice</span><br/><span class="hl-4">newListeners</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">]();</span><br/><span class="hl-4">emitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'log'</span><span class="hl-1">);</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">emitter</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'log once'</span><span class="hl-1">));</span><br/><br/><span class="hl-7">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-7">// `listener` which contains the original listener bound above</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">listeners</span><span class="hl-1"> = </span><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">rawListeners</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">logFnWrapper</span><span class="hl-1"> = </span><span class="hl-0">listeners</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">];</span><br/><br/><span class="hl-7">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-0">logFnWrapper</span><span class="hl-1">.</span><span class="hl-4">listener</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-4">logFnWrapper</span><span class="hl-1">();</span><br/><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'log persistently'</span><span class="hl-1">));</span><br/><span class="hl-7">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">newListeners</span><span class="hl-1"> = </span><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">rawListeners</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Logs "log persistently" twice</span><br/><span class="hl-0">newListeners</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">]();</span><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'log'</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v9.4.0</p>
|
||||
@@ -2040,7 +2040,7 @@ component or module (e.g. sockets or file streams).</p>
|
||||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><a href="#removeListener.removeListener-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callback</span><span class="hl-1"> = (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, </span><span class="hl-4">callback</span><span class="hl-1">);</span><br/><span class="hl-5">// ...</span><br/><span class="hl-4">server</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-7">'connection'</span><span class="hl-1">, </span><span class="hl-4">callback</span><span class="hl-1">);</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">callback</span><span class="hl-1"> = (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, </span><span class="hl-0">callback</span><span class="hl-1">);</span><br/><span class="hl-7">// ...</span><br/><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-4">removeListener</span><span class="hl-1">(</span><span class="hl-5">'connection'</span><span class="hl-1">, </span><span class="hl-0">callback</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
<p><code>removeListener()</code> will remove, at most, one instance of a listener from the
|
||||
listener array. If any single listener has been added multiple times to the
|
||||
@@ -2049,7 +2049,7 @@ called multiple times to remove each instance.</p>
|
||||
<p>Once an event is emitted, all listeners attached to it at the
|
||||
time of emitting are called in order. This implies that any<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and_before_ the last listener finishes execution will
|
||||
not remove them from<code>emit()</code> in progress. Subsequent events behave as expected.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">MyEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callbackA</span><span class="hl-1"> = () </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'A'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-4">callbackB</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callbackB</span><span class="hl-1"> = () </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'B'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-4">callbackA</span><span class="hl-1">);</span><br/><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, </span><span class="hl-4">callbackB</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-5">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span><br/><span class="hl-5">// B</span><br/><br/><span class="hl-5">// callbackB is now removed.</span><br/><span class="hl-5">// Internal listener array [callbackA]</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEmitter</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">MyEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">callbackA</span><span class="hl-1"> = () </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'A'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">removeListener</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackB</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">callbackB</span><span class="hl-1"> = () </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'B'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackA</span><span class="hl-1">);</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackB</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-7">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span><br/><span class="hl-7">// B</span><br/><br/><span class="hl-7">// callbackB is now removed.</span><br/><span class="hl-7">// Internal listener array [callbackA]</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span>
|
||||
</code></pre>
|
||||
<p>Because listeners are managed using an internal array, calling this will
|
||||
change the position indices of any listener registered <em>after</em> the listener
|
||||
@@ -2059,7 +2059,7 @@ the <code>emitter.listeners()</code> method will need to be recreated.</p>
|
||||
<p>When a single function has been added as a handler multiple times for a single
|
||||
event (as in the example below), <code>removeListener()</code> will remove the most
|
||||
recently added instance. In the example the <code>once('ping')</code>listener is removed:</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">pong</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'pong'</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">, </span><span class="hl-4">pong</span><span class="hl-1">);</span><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">, </span><span class="hl-4">pong</span><span class="hl-1">);</span><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">, </span><span class="hl-4">pong</span><span class="hl-1">);</span><br/><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">);</span><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'ping'</span><span class="hl-1">);</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">pong</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'pong'</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">removeListener</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'ping'</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
@@ -2119,7 +2119,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
||||
the emitter.</p>
|
||||
<p>For <code>EventTarget</code>s this is the only way to get the event listeners for the
|
||||
event target. This is useful for debugging and diagnostic purposes.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">getEventListeners</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">listener</span><span class="hl-1"> = () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-4">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">getEventListeners</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-1">}</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">et</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">listener</span><span class="hl-1"> = () </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">et</span><span class="hl-1">.</span><span class="hl-3">addEventListener</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-4">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">getEventListeners</span><span class="hl-1">(</span><span class="hl-4">et</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-1">}</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">getEventListeners</span><span class="hl-1">, </span><span class="hl-3">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">listener</span><span class="hl-1"> = () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-0">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">getEventListeners</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-1">}</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">et</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-4">listener</span><span class="hl-1"> = () </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">et</span><span class="hl-1">.</span><span class="hl-4">addEventListener</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-0">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">getEventListeners</span><span class="hl-1">(</span><span class="hl-0">et</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-1">}</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v15.2.0, v14.17.0</p>
|
||||
@@ -2141,7 +2141,7 @@ event target. This is useful for debugging and diagnostic purposes.</p>
|
||||
<li class="tsd-signature tsd-anchor-link" id="listenerCount-2.listenerCount-3">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount-2.listenerCount-3" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">listenerCount</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><span class="hl-4">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-7">'event'</span><span class="hl-1">, () </span><span class="hl-0">=></span><span class="hl-1"> {});</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-3">listenerCount</span><span class="hl-1">(</span><span class="hl-4">myEmitter</span><span class="hl-1">, </span><span class="hl-7">'event'</span><span class="hl-1">));</span><br/><span class="hl-5">// Prints: 2</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">EventEmitter</span><span class="hl-1">, </span><span class="hl-3">listenerCount</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">myEmitter</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'event'</span><span class="hl-1">, () </span><span class="hl-2">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">listenerCount</span><span class="hl-1">(</span><span class="hl-0">myEmitter</span><span class="hl-1">, </span><span class="hl-5">'event'</span><span class="hl-1">));</span><br/><span class="hl-7">// Prints: 2</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.9.12</p>
|
||||
@@ -2168,14 +2168,14 @@ event target. This is useful for debugging and diagnostic purposes.</p>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
<li class="tsd-signature tsd-anchor-link" id="on-10.on-11">on<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#on-10.on-11" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">on</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">(</span><span class="hl-0">async</span><span class="hl-1"> () </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-7">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">for</span><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">event</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-5">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-5">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-5">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">event</span><span class="hl-1">); </span><span class="hl-5">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-5">// Unreachable here</span><br/><span class="hl-1">})();</span>
|
||||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">on</span><span class="hl-1">, </span><span class="hl-3">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">(</span><span class="hl-2">async</span><span class="hl-1"> () </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-5">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">for</span><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> (</span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">event</span><span class="hl-1"> </span><span class="hl-2">of</span><span class="hl-1"> </span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-1">})();</span>
|
||||
</code></pre>
|
||||
<p>Returns an <code>AsyncIterator</code> that iterates <code>eventName</code> events. It will throw
|
||||
if the <code>EventEmitter</code> emits <code>'error'</code>. It removes all listeners when
|
||||
exiting the loop. The <code>value</code> returned by each iteration is an array
|
||||
composed of the emitted event arguments.</p>
|
||||
<p>An <code>AbortSignal</code> can be used to cancel waiting on events:</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">on</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ac</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-1">(</span><span class="hl-0">async</span><span class="hl-1"> () </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-7">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">for</span><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">event</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">, { </span><span class="hl-4">signal:</span><span class="hl-1"> </span><span class="hl-4">ac</span><span class="hl-1">.</span><span class="hl-4">signal</span><span class="hl-1"> })) {</span><br/><span class="hl-1"> </span><span class="hl-5">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-5">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-5">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">event</span><span class="hl-1">); </span><span class="hl-5">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-5">// Unreachable here</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">ac</span><span class="hl-1">.</span><span class="hl-3">abort</span><span class="hl-1">());</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">on</span><span class="hl-1">, </span><span class="hl-3">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ac</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-1">(</span><span class="hl-2">async</span><span class="hl-1"> () </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-5">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">for</span><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> (</span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">event</span><span class="hl-1"> </span><span class="hl-2">of</span><span class="hl-1"> </span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">, { </span><span class="hl-0">signal:</span><span class="hl-1"> </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-0">signal</span><span class="hl-1"> })) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-4">abort</span><span class="hl-1">());</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v13.6.0, v12.16.0</p>
|
||||
@@ -2208,15 +2208,15 @@ The <code>Promise</code> will resolve with an array of all the arguments emitted
|
||||
given event.</p>
|
||||
<p>This method is intentionally generic and works with the web platform <a href="https://dom.spec.whatwg.org/#interface-eventtarget">EventTarget</a> interface, which has no special<code>'error'</code> event
|
||||
semantics and does not listen to the <code>'error'</code> event.</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">once</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'myevent'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> [</span><span class="hl-2">value</span><span class="hl-1">] = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">value</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">err</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-8">Error</span><span class="hl-1">(</span><span class="hl-7">'kaboom'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'error'</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-4">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'error happened'</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">run</span><span class="hl-1">();</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">once</span><span class="hl-1">, </span><span class="hl-3">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-2">async</span><span class="hl-1"> </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">run</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'myevent'</span><span class="hl-1">, </span><span class="hl-9">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> [</span><span class="hl-3">value</span><span class="hl-1">] = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">value</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">err</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Error</span><span class="hl-1">(</span><span class="hl-5">'kaboom'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-4">nextTick</span><span class="hl-1">(() </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'error'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-0">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'error happened'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">run</span><span class="hl-1">();</span>
|
||||
</code></pre>
|
||||
<p>The special handling of the <code>'error'</code> event is only used when <code>events.once()</code>is used to wait for another event. If <code>events.once()</code> is used to wait for the
|
||||
'<code>error'</code> event itself, then it is treated as any other kind of event without
|
||||
special handling:</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">once</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'error'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-3">then</span><span class="hl-1">(([</span><span class="hl-4">err</span><span class="hl-1">]) </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'ok'</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">.</span><span class="hl-4">message</span><span class="hl-1">))</span><br/><span class="hl-1"> .</span><span class="hl-3">catch</span><span class="hl-1">((</span><span class="hl-4">err</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'error'</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">.</span><span class="hl-4">message</span><span class="hl-1">));</span><br/><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'error'</span><span class="hl-1">, </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-8">Error</span><span class="hl-1">(</span><span class="hl-7">'boom'</span><span class="hl-1">));</span><br/><br/><span class="hl-5">// Prints: ok boom</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">EventEmitter</span><span class="hl-1">, </span><span class="hl-3">once</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'error'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-4">then</span><span class="hl-1">(([</span><span class="hl-0">err</span><span class="hl-1">]) </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'ok'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">))</span><br/><span class="hl-1"> .</span><span class="hl-4">catch</span><span class="hl-1">((</span><span class="hl-0">err</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'error'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">));</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'error'</span><span class="hl-1">, </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Error</span><span class="hl-1">(</span><span class="hl-5">'boom'</span><span class="hl-1">));</span><br/><br/><span class="hl-7">// Prints: ok boom</span>
|
||||
</code></pre>
|
||||
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
|
||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">once</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-7">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ac</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">foo</span><span class="hl-1">(</span><span class="hl-4">emitter</span><span class="hl-1">, </span><span class="hl-4">event</span><span class="hl-1">, </span><span class="hl-4">signal</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">emitter</span><span class="hl-1">, </span><span class="hl-4">event</span><span class="hl-1">, { </span><span class="hl-4">signal</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-7">'event emitted!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-4">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1"> (</span><span class="hl-4">error</span><span class="hl-1">.</span><span class="hl-4">name</span><span class="hl-1"> === </span><span class="hl-7">'AbortError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">error</span><span class="hl-1">(</span><span class="hl-7">'Waiting for the event was canceled!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">error</span><span class="hl-1">(</span><span class="hl-7">'There was an error'</span><span class="hl-1">, </span><span class="hl-4">error</span><span class="hl-1">.</span><span class="hl-4">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">foo</span><span class="hl-1">(</span><span class="hl-4">ee</span><span class="hl-1">, </span><span class="hl-7">'foo'</span><span class="hl-1">, </span><span class="hl-4">ac</span><span class="hl-1">.</span><span class="hl-4">signal</span><span class="hl-1">);</span><br/><span class="hl-4">ac</span><span class="hl-1">.</span><span class="hl-3">abort</span><span class="hl-1">(); </span><span class="hl-5">// Abort waiting for the event</span><br/><span class="hl-4">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-7">'foo'</span><span class="hl-1">); </span><span class="hl-5">// Prints: Waiting for the event was canceled!</span>
|
||||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">EventEmitter</span><span class="hl-1">, </span><span class="hl-3">once</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ee</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ac</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-2">async</span><span class="hl-1"> </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">foo</span><span class="hl-1">(</span><span class="hl-0">emitter</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">, </span><span class="hl-0">signal</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">once</span><span class="hl-1">(</span><span class="hl-0">emitter</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">, { </span><span class="hl-0">signal</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">'event emitted!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-5">'AbortError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">error</span><span class="hl-1">(</span><span class="hl-5">'Waiting for the event was canceled!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-6">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">error</span><span class="hl-1">(</span><span class="hl-5">'There was an error'</span><span class="hl-1">, </span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">foo</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-5">'foo'</span><span class="hl-1">, </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-0">signal</span><span class="hl-1">);</span><br/><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-4">abort</span><span class="hl-1">(); </span><span class="hl-7">// Abort waiting for the event</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-4">emit</span><span class="hl-1">(</span><span class="hl-5">'foo'</span><span class="hl-1">); </span><span class="hl-7">// Prints: Waiting for the event was canceled!</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v11.13.0, v10.16.0</p>
|
||||
@@ -2259,7 +2259,7 @@ added for a particular event. This is a useful default that helps finding
|
||||
memory leaks. The <code>EventEmitter.setMaxListeners()</code> method allows the default limit to be
|
||||
modified (if eventTargets is empty) or modify the limit specified in every <code>EventTarget</code> | <code>EventEmitter</code> passed as arguments.
|
||||
The value can be set to<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
|
||||
<pre><code class="language-js"><span class="hl-4">EventEmitter</span><span class="hl-1">.</span><span class="hl-3">setMaxListeners</span><span class="hl-1">(</span><span class="hl-9">20</span><span class="hl-1">);</span><br/><span class="hl-5">// Equivalent to</span><br/><span class="hl-4">EventEmitter</span><span class="hl-1">.</span><span class="hl-4">defaultMaxListeners</span><span class="hl-1"> = </span><span class="hl-9">20</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">eventTarget</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-5">// Only way to increase limit for `EventTarget` instances</span><br/><span class="hl-5">// as these doesn't expose its own `setMaxListeners` method</span><br/><span class="hl-4">EventEmitter</span><span class="hl-1">.</span><span class="hl-3">setMaxListeners</span><span class="hl-1">(</span><span class="hl-9">20</span><span class="hl-1">, </span><span class="hl-4">eventTarget</span><span class="hl-1">);</span>
|
||||
<pre><code class="language-js"><span class="hl-0">EventEmitter</span><span class="hl-1">.</span><span class="hl-4">setMaxListeners</span><span class="hl-1">(</span><span class="hl-9">20</span><span class="hl-1">);</span><br/><span class="hl-7">// Equivalent to</span><br/><span class="hl-0">EventEmitter</span><span class="hl-1">.</span><span class="hl-0">defaultMaxListeners</span><span class="hl-1"> = </span><span class="hl-9">20</span><span class="hl-1">;</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">eventTarget</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-7">// Only way to increase limit for `EventTarget` instances</span><br/><span class="hl-7">// as these doesn't expose its own `setMaxListeners` method</span><br/><span class="hl-0">EventEmitter</span><span class="hl-1">.</span><span class="hl-4">setMaxListeners</span><span class="hl-1">(</span><span class="hl-9">20</span><span class="hl-1">, </span><span class="hl-0">eventTarget</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
|
||||
<h3>Since</h3><p>v15.3.0, v14.17.0</p>
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
<li><a href="TimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">TimeoutError</a></li>
|
||||
<li><a href="ResponseFormatError.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseFormatError</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L78">packages/xrpl/src/errors.ts:78</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L78">packages/xrpl/src/errors.ts:78</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">
|
||||
@@ -41,11 +41,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="ConnectionError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="ConnectionError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="ConnectionError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="ConnectionError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="ConnectionError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="ConnectionError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="ConnectionError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="ConnectionError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="ConnectionError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -77,7 +77,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <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/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -85,19 +85,19 @@
|
||||
<div class="tsd-signature">data<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -151,7 +151,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -164,7 +164,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -210,11 +210,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="ConnectionError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Connection<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ConnectionError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ConnectionError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ConnectionError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ConnectionError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ConnectionError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">DisconnectedError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L92">packages/xrpl/src/errors.ts:92</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L92">packages/xrpl/src/errors.ts:92</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">
|
||||
@@ -35,11 +35,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="DisconnectedError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="DisconnectedError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="DisconnectedError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="DisconnectedError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="DisconnectedError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="DisconnectedError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="DisconnectedError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="DisconnectedError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="DisconnectedError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -71,7 +71,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="DisconnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">DisconnectedError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -79,19 +79,19 @@
|
||||
<div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -145,7 +145,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -158,7 +158,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -204,11 +204,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="DisconnectedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Disconnected<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="DisconnectedError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="DisconnectedError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="DisconnectedError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="DisconnectedError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="DisconnectedError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">NotConnectedError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L85">packages/xrpl/src/errors.ts:85</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L85">packages/xrpl/src/errors.ts:85</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">
|
||||
@@ -35,11 +35,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="NotConnectedError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="NotConnectedError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="NotConnectedError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="NotConnectedError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="NotConnectedError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="NotConnectedError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="NotConnectedError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="NotConnectedError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="NotConnectedError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -71,7 +71,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="NotConnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">NotConnectedError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -79,19 +79,19 @@
|
||||
<div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -145,7 +145,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -158,7 +158,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -204,11 +204,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="NotConnectedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Not<wbr/>Connected<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotConnectedError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotConnectedError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotConnectedError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotConnectedError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotConnectedError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -24,7 +24,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/5fc1c795/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/91f4950b/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">
|
||||
@@ -36,11 +36,11 @@ From rippled.</p>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="NotFoundError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="NotFoundError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="NotFoundError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="NotFoundError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="NotFoundError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="NotFoundError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="NotFoundError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="NotFoundError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="NotFoundError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -68,7 +68,7 @@ From rippled.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="NotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">NotFoundError</a></h4><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/5fc1c795/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/91f4950b/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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -76,19 +76,19 @@ From rippled.</p>
|
||||
<div class="tsd-signature">data<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -142,7 +142,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -155,7 +155,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -201,11 +201,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="NotFoundError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Not<wbr/>Found<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="NotFoundError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotFoundError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotFoundError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotFoundError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotFoundError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotFoundError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">ResponseFormatError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L113">packages/xrpl/src/errors.ts:113</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L113">packages/xrpl/src/errors.ts:113</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">
|
||||
@@ -35,11 +35,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="ResponseFormatError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="ResponseFormatError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="ResponseFormatError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="ResponseFormatError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="ResponseFormatError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="ResponseFormatError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="ResponseFormatError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="ResponseFormatError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="ResponseFormatError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -71,7 +71,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="ResponseFormatError.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseFormatError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -79,19 +79,19 @@
|
||||
<div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -145,7 +145,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -158,7 +158,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -204,11 +204,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="ResponseFormatError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Response<wbr/>Format<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ResponseFormatError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ResponseFormatError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ResponseFormatError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ResponseFormatError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ResponseFormatError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">RippledError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L64">packages/xrpl/src/errors.ts:64</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L64">packages/xrpl/src/errors.ts:64</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">
|
||||
@@ -35,11 +35,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="RippledError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="RippledError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="RippledError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="RippledError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="RippledError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="RippledError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="RippledError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="RippledError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="RippledError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -71,7 +71,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="RippledError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <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/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -79,19 +79,19 @@
|
||||
<div class="tsd-signature">data<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -145,7 +145,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -158,7 +158,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -204,11 +204,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="RippledError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Rippled<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">RippledNotInitializedError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L99">packages/xrpl/src/errors.ts:99</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L99">packages/xrpl/src/errors.ts:99</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">
|
||||
@@ -35,11 +35,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="RippledNotInitializedError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="RippledNotInitializedError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="RippledNotInitializedError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="RippledNotInitializedError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="RippledNotInitializedError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="RippledNotInitializedError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="RippledNotInitializedError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="RippledNotInitializedError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="RippledNotInitializedError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -71,7 +71,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="RippledNotInitializedError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledNotInitializedError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -79,19 +79,19 @@
|
||||
<div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -145,7 +145,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -158,7 +158,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -204,11 +204,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="RippledNotInitializedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Rippled<wbr/>Not<wbr/>Initialized<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledNotInitializedError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledNotInitializedError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledNotInitializedError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledNotInitializedError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledNotInitializedError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">TimeoutError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L106">packages/xrpl/src/errors.ts:106</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L106">packages/xrpl/src/errors.ts:106</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">
|
||||
@@ -35,11 +35,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="TimeoutError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="TimeoutError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="TimeoutError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="TimeoutError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="TimeoutError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="TimeoutError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="TimeoutError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="TimeoutError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="TimeoutError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -71,7 +71,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="TimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">TimeoutError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -79,19 +79,19 @@
|
||||
<div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -145,7 +145,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -158,7 +158,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -204,11 +204,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="TimeoutError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Timeout<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TimeoutError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TimeoutError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TimeoutError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TimeoutError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TimeoutError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">UnexpectedError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L71">packages/xrpl/src/errors.ts:71</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L71">packages/xrpl/src/errors.ts:71</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">
|
||||
@@ -35,11 +35,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="UnexpectedError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="UnexpectedError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="UnexpectedError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="UnexpectedError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="UnexpectedError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="UnexpectedError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="UnexpectedError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="UnexpectedError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="UnexpectedError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -71,7 +71,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="UnexpectedError.html" class="tsd-signature-type" data-tsd-kind="Class">UnexpectedError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <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/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -79,19 +79,19 @@
|
||||
<div class="tsd-signature">data<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -145,7 +145,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -158,7 +158,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -204,11 +204,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="UnexpectedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Unexpected<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="UnexpectedError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="UnexpectedError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="UnexpectedError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="UnexpectedError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="UnexpectedError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">ValidationError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L120">packages/xrpl/src/errors.ts:120</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L120">packages/xrpl/src/errors.ts:120</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">
|
||||
@@ -35,11 +35,11 @@
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="ValidationError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="ValidationError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="ValidationError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="ValidationError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="ValidationError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="ValidationError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="ValidationError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="ValidationError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="ValidationError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -71,7 +71,7 @@
|
||||
<h4 class="tsd-returns-title">Returns <a href="ValidationError.html" class="tsd-signature-type" data-tsd-kind="Class">ValidationError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <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/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -79,19 +79,19 @@
|
||||
<div class="tsd-signature">data<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -145,7 +145,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -158,7 +158,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -204,11 +204,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="ValidationError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Validation<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ValidationError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ValidationError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ValidationError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ValidationError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ValidationError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
A wallet can be derived from either a seed, mnemonic, or entropy (array of random numbers).
|
||||
It provides functionality to sign/verify transactions offline.</p>
|
||||
|
||||
<h3>Example</h3><pre><code class="language-typescript"><span class="hl-5">// Derive a wallet from a bip39 Mnemonic</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">wallet</span><span class="hl-1"> = </span><span class="hl-4">Wallet</span><span class="hl-1">.</span><span class="hl-3">fromMnemonic</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-7">'jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry'</span><br/><span class="hl-1">)</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">wallet</span><span class="hl-1">)</span><br/><span class="hl-5">// Wallet {</span><br/><span class="hl-5">// publicKey: '02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2',</span><br/><span class="hl-5">// privateKey: '00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2',</span><br/><span class="hl-5">// classicAddress: 'rwZiksrExmVkR64pf87Jor4cYbmff47SUm',</span><br/><span class="hl-5">// seed: undefined</span><br/><span class="hl-5">// }.</span><br/><br/><span class="hl-5">// Derive a wallet from a base58 encoded seed.</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">seedWallet</span><span class="hl-1"> = </span><span class="hl-4">Wallet</span><span class="hl-1">.</span><span class="hl-3">fromSeed</span><span class="hl-1">(</span><span class="hl-7">'ssZkdwURFMBXenJPbrpE14b6noJSu'</span><span class="hl-1">)</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">seedWallet</span><span class="hl-1">)</span><br/><span class="hl-5">// Wallet {</span><br/><span class="hl-5">// publicKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',</span><br/><span class="hl-5">// privateKey: '00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7',</span><br/><span class="hl-5">// classicAddress: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo',</span><br/><span class="hl-5">// seed: 'ssZkdwURFMBXenJPbrpE14b6noJSu'</span><br/><span class="hl-5">// }.</span><br/><br/><span class="hl-5">// Sign a JSON Transaction</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">signed</span><span class="hl-1"> = </span><span class="hl-4">seedWallet</span><span class="hl-1">.</span><span class="hl-3">signTransaction</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">TransactionType:</span><span class="hl-1"> </span><span class="hl-7">'Payment'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">Account:</span><span class="hl-1"> </span><span class="hl-7">'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'</span><br/><span class="hl-1"> ...........</span><br/><span class="hl-1">}).</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">signed</span><span class="hl-1">)</span><br/><span class="hl-5">// '1200007321......B01BE1DFF3'.</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-3">decode</span><span class="hl-1">(</span><span class="hl-4">signed</span><span class="hl-1">))</span><br/><span class="hl-5">// {</span><br/><span class="hl-5">// TransactionType: 'Payment',</span><br/><span class="hl-5">// SigningPubKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',</span><br/><span class="hl-5">// TxnSignature: '3045022100AAD......5B631ABD21171B61B07D304',</span><br/><span class="hl-5">// Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'</span><br/><span class="hl-5">// ...........</span><br/><span class="hl-5">// }</span>
|
||||
<h3>Example</h3><pre><code class="language-typescript"><span class="hl-7">// Derive a wallet from a bip39 Mnemonic</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">wallet</span><span class="hl-1"> = </span><span class="hl-0">Wallet</span><span class="hl-1">.</span><span class="hl-4">fromMnemonic</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-5">'jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry'</span><br/><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">wallet</span><span class="hl-1">)</span><br/><span class="hl-7">// Wallet {</span><br/><span class="hl-7">// publicKey: '02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2',</span><br/><span class="hl-7">// privateKey: '00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2',</span><br/><span class="hl-7">// classicAddress: 'rwZiksrExmVkR64pf87Jor4cYbmff47SUm',</span><br/><span class="hl-7">// seed: undefined</span><br/><span class="hl-7">// }.</span><br/><br/><span class="hl-7">// Derive a wallet from a base58 encoded seed.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">seedWallet</span><span class="hl-1"> = </span><span class="hl-0">Wallet</span><span class="hl-1">.</span><span class="hl-4">fromSeed</span><span class="hl-1">(</span><span class="hl-5">'ssZkdwURFMBXenJPbrpE14b6noJSu'</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">seedWallet</span><span class="hl-1">)</span><br/><span class="hl-7">// Wallet {</span><br/><span class="hl-7">// publicKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',</span><br/><span class="hl-7">// privateKey: '00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7',</span><br/><span class="hl-7">// classicAddress: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo',</span><br/><span class="hl-7">// seed: 'ssZkdwURFMBXenJPbrpE14b6noJSu'</span><br/><span class="hl-7">// }.</span><br/><br/><span class="hl-7">// Sign a JSON Transaction</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">signed</span><span class="hl-1"> = </span><span class="hl-0">seedWallet</span><span class="hl-1">.</span><span class="hl-4">signTransaction</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">'Payment'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-5">'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'</span><br/><span class="hl-1"> ...........</span><br/><span class="hl-1">}).</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">signed</span><span class="hl-1">)</span><br/><span class="hl-7">// '1200007321......B01BE1DFF3'.</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">decode</span><span class="hl-1">(</span><span class="hl-0">signed</span><span class="hl-1">))</span><br/><span class="hl-7">// {</span><br/><span class="hl-7">// TransactionType: 'Payment',</span><br/><span class="hl-7">// SigningPubKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',</span><br/><span class="hl-7">// TxnSignature: '3045022100AAD......5B631ABD21171B61B07D304',</span><br/><span class="hl-7">// Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'</span><br/><span class="hl-7">// ...........</span><br/><span class="hl-7">// }</span>
|
||||
</code></pre>
|
||||
</div></section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
@@ -26,7 +26,7 @@ It provides functionality to sign/verify transactions offline.</p>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">Wallet</span></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L94">packages/xrpl/src/Wallet/index.ts:94</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L94">packages/xrpl/src/Wallet/index.ts:94</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">
|
||||
@@ -41,7 +41,7 @@ It provides functionality to sign/verify transactions offline.</p>
|
||||
<div class="tsd-index-list"><a href="Wallet.html#classicAddress" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>classic<wbr/>Address</span></a>
|
||||
<a href="Wallet.html#privateKey" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>private<wbr/>Key</span></a>
|
||||
<a href="Wallet.html#publicKey" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>public<wbr/>Key</span></a>
|
||||
<a href="Wallet.html#seed" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>seed</span></a>
|
||||
<a href="Wallet.html#seed" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>seed?</span></a>
|
||||
<a href="Wallet.html#fromSecret" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>from<wbr/>Secret</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -66,7 +66,7 @@ It provides functionality to sign/verify transactions offline.</p>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Wallet">new <wbr/>Wallet<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#constructor.new_Wallet" 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></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Wallet">new <wbr/>Wallet<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>seed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#constructor.new_Wallet" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Creates a new Wallet.</p>
|
||||
</div>
|
||||
@@ -82,7 +82,7 @@ It provides functionality to sign/verify transactions offline.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>The private key used for signing transactions for the account.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>seed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options to initialize a Wallet.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -96,38 +96,38 @@ It provides functionality to sign/verify transactions offline.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L118">packages/xrpl/src/Wallet/index.ts:118</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L118">packages/xrpl/src/Wallet/index.ts:118</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-kind-property tsd-parent-kind-class"><a id="classicAddress" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>classic<wbr/>Address</span><a href="#classicAddress" 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">classic<wbr/>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L97">packages/xrpl/src/Wallet/index.ts:97</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L97">packages/xrpl/src/Wallet/index.ts:97</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="privateKey" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>private<wbr/>Key</span><a href="#privateKey" 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">private<wbr/>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L96">packages/xrpl/src/Wallet/index.ts:96</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L96">packages/xrpl/src/Wallet/index.ts:96</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="publicKey" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>public<wbr/>Key</span><a href="#publicKey" 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">public<wbr/>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L95">packages/xrpl/src/Wallet/index.ts:95</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L95">packages/xrpl/src/Wallet/index.ts:95</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="seed" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>seed</span><a href="#seed" 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">seed<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L98">packages/xrpl/src/Wallet/index.ts:98</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L98">packages/xrpl/src/Wallet/index.ts:98</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="fromSecret" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Secret</span><a href="#fromSecret" 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">from<wbr/>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = Wallet.fromSeed</span></div>
|
||||
<div class="tsd-signature">from<wbr/>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = Wallet.fromSeed</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
||||
<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
|
||||
<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Derives a wallet from a seed.</p>
|
||||
|
||||
@@ -141,7 +141,7 @@ It provides functionality to sign/verify transactions offline.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>A string used to generate a keypair (publicKey/privateKey) to derive a wallet.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options to derive a Wallet.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -155,7 +155,7 @@ It provides functionality to sign/verify transactions offline.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L174">packages/xrpl/src/Wallet/index.ts:174</a></li></ul></aside></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L174">packages/xrpl/src/Wallet/index.ts:174</a></li></ul></aside></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="address" class="tsd-anchor"></a>
|
||||
@@ -169,7 +169,7 @@ It provides functionality to sign/verify transactions offline.</p>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L105">packages/xrpl/src/Wallet/index.ts:105</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L105">packages/xrpl/src/Wallet/index.ts:105</a></li></ul></aside></li></ul></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="checkTxSerialization" class="tsd-anchor"></a>
|
||||
@@ -199,7 +199,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L408">packages/xrpl/src/Wallet/index.ts:408</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L408">packages/xrpl/src/Wallet/index.ts:408</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getXAddress" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>getXAddress</span><a href="#getXAddress" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -222,11 +222,11 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L392">packages/xrpl/src/Wallet/index.ts:392</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L392">packages/xrpl/src/Wallet/index.ts:392</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="sign" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>sign</span><a href="#sign" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-anchor-link" id="sign.sign-1">sign<span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, transaction<span class="tsd-signature-symbol">: </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, multisign<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tx_blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><a href="#sign.sign-1" 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></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="sign.sign-1">sign<span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, transaction<span class="tsd-signature-symbol">: </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, multisign<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>tx_blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#sign.sign-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Signs a transaction offline.</p>
|
||||
|
||||
@@ -251,14 +251,14 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> multisign: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>Specify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tx_blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>tx_blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>tx_<wbr/>blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L317">packages/xrpl/src/Wallet/index.ts:317</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L317">packages/xrpl/src/Wallet/index.ts:317</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="verifyTransaction" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>verify<wbr/>Transaction</span><a href="#verifyTransaction" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -277,11 +277,11 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L378">packages/xrpl/src/Wallet/index.ts:378</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L378">packages/xrpl/src/Wallet/index.ts:378</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="deriveWallet" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>derive<wbr/>Wallet</span><a href="#deriveWallet" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<li class="tsd-signature tsd-anchor-link" id="deriveWallet.deriveWallet-1">derive<wbr/>Wallet<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#deriveWallet.deriveWallet-1" 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></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="deriveWallet.deriveWallet-1">derive<wbr/>Wallet<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#deriveWallet.deriveWallet-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Derive a Wallet from a seed.</p>
|
||||
|
||||
@@ -295,7 +295,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>The seed used to derive the wallet.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options to derive a Wallet.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -309,11 +309,11 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L293">packages/xrpl/src/Wallet/index.ts:293</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L293">packages/xrpl/src/Wallet/index.ts:293</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromEntropy" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Entropy</span><a href="#fromEntropy" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-anchor-link" id="fromEntropy.fromEntropy-1">from<wbr/>Entropy<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#fromEntropy.fromEntropy-1" 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></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="fromEntropy.fromEntropy-1">from<wbr/>Entropy<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#fromEntropy.fromEntropy-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Derives a wallet from an entropy (array of random numbers).</p>
|
||||
|
||||
@@ -327,7 +327,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>An array of random numbers to generate a seed used to derive a wallet.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options to derive a Wallet.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -341,11 +341,11 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L185">packages/xrpl/src/Wallet/index.ts:185</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L185">packages/xrpl/src/Wallet/index.ts:185</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromMnemonic" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Mnemonic</span><a href="#fromMnemonic" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-anchor-link" id="fromMnemonic.fromMnemonic-1">from<wbr/>Mnemonic<span class="tsd-signature-symbol">(</span>mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>derivationPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mnemonicEncoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"bip39"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rfc1751"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#fromMnemonic.fromMnemonic-1" 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></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="fromMnemonic.fromMnemonic-1">from<wbr/>Mnemonic<span class="tsd-signature-symbol">(</span>mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>derivationPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>mnemonicEncoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"bip39"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rfc1751"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#fromMnemonic.fromMnemonic-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Derives a wallet from a bip39 or RFC1751 mnemonic (Defaults to bip39).</p>
|
||||
|
||||
@@ -361,7 +361,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>A string consisting of words (whitespace delimited) used to derive a wallet.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>derivationPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mnemonicEncoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"bip39"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rfc1751"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>derivationPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>mnemonicEncoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"bip39"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rfc1751"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options to derive a Wallet.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -386,11 +386,11 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L216">packages/xrpl/src/Wallet/index.ts:216</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L216">packages/xrpl/src/Wallet/index.ts:216</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fromRFC1751Mnemonic" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>fromRFC1751<wbr/>Mnemonic</span><a href="#fromRFC1751Mnemonic" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<li class="tsd-signature tsd-anchor-link" id="fromRFC1751Mnemonic.fromRFC1751Mnemonic-1">fromRFC1751<wbr/>Mnemonic<span class="tsd-signature-symbol">(</span>mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#fromRFC1751Mnemonic.fromRFC1751Mnemonic-1" 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></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="fromRFC1751Mnemonic.fromRFC1751Mnemonic-1">fromRFC1751<wbr/>Mnemonic<span class="tsd-signature-symbol">(</span>mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#fromRFC1751Mnemonic.fromRFC1751Mnemonic-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Derives a wallet from a RFC1751 mnemonic, which is how <code>wallet_propose</code> encodes mnemonics.</p>
|
||||
|
||||
@@ -404,7 +404,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>A string consisting of words (whitespace delimited) used to derive a wallet.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options to derive a Wallet.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -418,11 +418,11 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L265">packages/xrpl/src/Wallet/index.ts:265</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L265">packages/xrpl/src/Wallet/index.ts:265</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromSeed" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Seed</span><a href="#fromSeed" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-anchor-link" id="fromSeed.fromSeed-1">from<wbr/>Seed<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#fromSeed.fromSeed-1" 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></li>
|
||||
<li class="tsd-signature tsd-anchor-link" id="fromSeed.fromSeed-1">from<wbr/>Seed<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><a href="#fromSeed.fromSeed-1" 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></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Derives a wallet from a seed.</p>
|
||||
|
||||
@@ -436,7 +436,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>A string used to generate a keypair (publicKey/privateKey) to derive a wallet.</p>
|
||||
</div></li>
|
||||
<li>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span><br/><span> </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>(Optional) Options to derive a Wallet.</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -450,7 +450,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L154">packages/xrpl/src/Wallet/index.ts:154</a></li></ul></aside></li></ul></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L154">packages/xrpl/src/Wallet/index.ts:154</a></li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="generate" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>generate</span><a href="#generate" 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -469,7 +469,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/Wallet/index.ts#L140">packages/xrpl/src/Wallet/index.ts:140</a></li></ul></aside></li></ul></section></section></div>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/Wallet/index.ts#L140">packages/xrpl/src/Wallet/index.ts:140</a></li></ul></aside></li></ul></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">
|
||||
@@ -500,7 +500,7 @@ the serialized Transaction desn't match the original transaction.</p>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#classicAddress" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>classic<wbr/>Address</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#privateKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>private<wbr/>Key</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#publicKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>public<wbr/>Key</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#seed" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>seed</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#seed" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>seed?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#fromSecret" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>from<wbr/>Secret</a></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Wallet.html#address" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>address</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="Wallet.html#checkTxSerialization" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>check<wbr/>Tx<wbr/>Serialization</a></li>
|
||||
|
||||
@@ -25,7 +25,7 @@ is connected to mainnet).</p>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">XRPLFaucetError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L129">packages/xrpl/src/errors.ts:129</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L129">packages/xrpl/src/errors.ts:129</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">
|
||||
@@ -37,11 +37,11 @@ is connected to mainnet).</p>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="XRPLFaucetError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="XRPLFaucetError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="XRPLFaucetError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="XRPLFaucetError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="XRPLFaucetError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="XRPLFaucetError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="XRPLFaucetError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="XRPLFaucetError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="XRPLFaucetError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -73,7 +73,7 @@ is connected to mainnet).</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="XRPLFaucetError.html" class="tsd-signature-type" data-tsd-kind="Class">XRPLFaucetError</a></h4><aside class="tsd-sources">
|
||||
<p>Inherited from <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/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
|
||||
@@ -81,19 +81,19 @@ is connected to mainnet).</p>
|
||||
<div class="tsd-signature">data<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">message<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">name<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/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -147,7 +147,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
@@ -160,7 +160,7 @@ us to customize its output:
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><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/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -206,11 +206,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="XRPLFaucetError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>XRPLFaucet<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XRPLFaucetError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XRPLFaucetError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XRPLFaucetError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XRPLFaucetError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XRPLFaucetError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
@@ -31,7 +31,7 @@ XrplErrors.</p>
|
||||
<li><a href="NotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">NotFoundError</a></li>
|
||||
<li><a href="XRPLFaucetError.html" class="tsd-signature-type" data-tsd-kind="Class">XRPLFaucetError</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L10">packages/xrpl/src/errors.ts:10</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L10">packages/xrpl/src/errors.ts:10</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">
|
||||
@@ -43,11 +43,11 @@ XrplErrors.</p>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="XrplError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data</span></a>
|
||||
<div class="tsd-index-list"><a href="XrplError.html#data" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>data?</span></a>
|
||||
<a href="XrplError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>message</span></a>
|
||||
<a href="XrplError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
||||
<a href="XrplError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
|
||||
<a href="XrplError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
|
||||
<a href="XrplError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
|
||||
<a href="XrplError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
|
||||
<a href="XrplError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
|
||||
</div></section>
|
||||
<section class="tsd-index-section">
|
||||
@@ -79,26 +79,26 @@ XrplErrors.</p>
|
||||
<h4 class="tsd-returns-title">Returns <a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides Error.constructor</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</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-kind-property tsd-parent-kind-class"><a id="data" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>data</span><a href="#data" 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">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><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 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">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Overrides Error.message</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><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 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">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
<p>Overrides Error.name</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
||||
@@ -151,7 +151,7 @@ us to customize its output:
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class"><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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
@@ -163,7 +163,7 @@ us to customize its output:
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/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/91f4950b/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-kind-method tsd-parent-kind-class 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 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>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||||
@@ -209,11 +209,11 @@ us to customize its output:
|
||||
<li class="current tsd-kind-class"><a href="XrplError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Xrpl<wbr/>Error</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="XrplError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="XrplError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="XrplError.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>data?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="XrplError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="XrplError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XrplError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XrplError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XrplError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XrplError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XrplError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="XrplError.html#inspect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>inspect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="XrplError.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>to<wbr/>String</a></li>
|
||||
|
||||
Reference in New Issue
Block a user