ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-05 21:35:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9d1fdb412ebaf03cfc5284543a770ed533260a50
xahau.js/docs/classes/BroadcastClient.html
ledhed2222 4f035fd0d6 custom faucet hosts and various typing fixes for NFT support that were originally missed (#1882) 
* various typing fixes for NFT support that were originally missed

* add optional faucet URL to fundWallet

* run docgen and commit changes

* fixes integration tests
2022-01-24 13:08:35 -05:00

667 lines
289 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BroadcastClient | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="BroadcastClient.html">BroadcastClient</a></li></ul><h1>Class BroadcastClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Client that can rely on multiple different servers.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><ul class="tsd-hierarchy"><li><span class="target">BroadcastClient</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section"><h3>Constructor</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="BroadcastClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section"><h3>Abstraction</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getBalances" class="tsd-kind-icon">get<wbr/>Balances</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getLedgerIndex" class="tsd-kind-icon">get<wbr/>Ledger<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getOrderbook" class="tsd-kind-icon">get<wbr/>Orderbook</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getXrpBalance" class="tsd-kind-icon">get<wbr/>Xrp<wbr/>Balance</a></li></ul></section><section class="tsd-index-section"><h3>Core</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#autofill" class="tsd-kind-icon">autofill</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#submit" class="tsd-kind-icon">submit</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#submitAndWait" class="tsd-kind-icon">submit<wbr/>And<wbr/>Wait</a></li></ul></section><section class="tsd-index-section"><h3>Faucet</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#fundWallet" class="tsd-kind-icon">fund<wbr/>Wallet</a></li></ul></section><section class="tsd-index-section"><h3>Fee</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#feeCushion" class="tsd-kind-icon">fee<wbr/>Cushion</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#maxFeeXRP" class="tsd-kind-icon">max<wbr/>FeeXRP</a></li></ul></section><section class="tsd-index-section"><h3>Network</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#disconnect" class="tsd-kind-icon">disconnect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#isConnected" class="tsd-kind-icon">is<wbr/>Connected</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="BroadcastClient.html#request" class="tsd-kind-icon">request</a></li></ul></section><section class="tsd-index-section"><h3>Other</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BroadcastClient.html#clients" class="tsd-kind-icon">clients</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#connection" class="tsd-kind-icon">connection</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#prepareTransaction" class="tsd-kind-icon">prepare<wbr/>Transaction</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BroadcastClient.html#getMethodNames" class="tsd-kind-icon">get<wbr/>Method<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#requestAll" class="tsd-kind-icon">request<wbr/>All</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#requestNextPage" class="tsd-kind-icon">request<wbr/>Next<wbr/>Page</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#getEventListeners" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#on-1" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#once-1" class="tsd-kind-icon">once</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-kind-class"><h2>Constructor</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Broadcast<wbr/>Client<span class="tsd-signature-symbol">(</span>servers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientOptions</a><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/BroadcastClient.ts#L18">packages/xrpl/src/client/BroadcastClient.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a new BroadcastClient.</p>
</div><dl class="tsd-comment-tags"><dt>category</dt><dd><p>Constructor</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>servers: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>An array of names of servers.</p>
</div></div></li><li><h5>options: <a href="../interfaces/ClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Options for the clients.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></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>get<wbr/>Balances</h3><div class="tsd-signature tsd-kind-icon">get<wbr/>Balances<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>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"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol"> = getBalances</span></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/61107e0a/packages/xrpl/src/client/index.ts#L620">packages/xrpl/src/client/index.ts:620</a></li></ul></aside><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 tsd-kind-icon"><span class="tsd-signature-symbol">(</span>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">&lt;</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">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get XRP/non-XRP balances for an account.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>address: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Address of the account to retrieve balances for.</p>
</div></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></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Allows the client to specify a ledger_hash, ledger_index,
filter by peer, and/or limit number of balances.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Retrieve the account balances at the ledger with
a given ledger_hash.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Retrieve the account balances at a given
ledger_index.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Limit number of balances to return.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Filter balances by peer.</p>
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>An array of XRP/non-XRP balances for the given account.</p>
</div></li></ul></li></ul></div></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>get<wbr/>Ledger<wbr/>Index</h3><div class="tsd-signature tsd-kind-icon">get<wbr/>Ledger<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = getLedgerIndex</span></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/61107e0a/packages/xrpl/src/client/index.ts#L630">packages/xrpl/src/client/index.ts:630</a></li></ul></aside><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 tsd-kind-icon"><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">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the index of the most recently validated ledger.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The most recently validated ledger index.</p>
</div></li></ul></li></ul></div></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>get<wbr/>Orderbook</h3><div class="tsd-signature tsd-kind-icon">get<wbr/>Orderbook<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>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"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol"> = getOrderbook</span></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/61107e0a/packages/xrpl/src/client/index.ts#L625">packages/xrpl/src/client/index.ts:625</a></li></ul></aside><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 tsd-kind-icon"><span class="tsd-signature-symbol">(</span>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">&lt;</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">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Fetch orderbook (buy/sell orders) between two accounts.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>takerPays: <span class="tsd-signature-type">TakerAmount</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specification of which currency the account taking the
offer would pay, as an object with <code>currency</code> and <code>issuer</code> fields.</p>
</div></div></li><li><h5>takerGets: <span class="tsd-signature-type">TakerAmount</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specification of which currency the account taking the
offer would receive, as an object with <code>currency</code> and <code>issuer</code> fields.</p>
</div></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></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Options allowing the client to specify ledger_index,
ledger_hash, filter by taker, and/or limit number of orders.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Retrieve the orderbook at the ledger with a
given ledger_hash.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Retrieve the orderbook at a given ledger_index.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Limit number of order books to fetch for each side of
the order book. Defaults to 20.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Filter orders by taker.</p>
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>An object containing buy and sell objects.</p>
</div></li></ul></li></ul></div></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>get<wbr/>Xrp<wbr/>Balance</h3><div class="tsd-signature tsd-kind-icon">get<wbr/>Xrp<wbr/>Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>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"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = getXrpBalance</span></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/61107e0a/packages/xrpl/src/client/index.ts#L615">packages/xrpl/src/client/index.ts:615</a></li></ul></aside><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 tsd-kind-icon"><span class="tsd-signature-symbol">(</span>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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the XRP balance for an account.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><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">&#39;rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn&#39;</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">/// &#39;200&#39;</span>
</code></pre>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>address: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Address of the account to retrieve XRP balance.</p>
</div></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></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Options to include for getting the XRP balance.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Retrieve the account balances at the ledger with
a given ledger_hash.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Retrieve the account balances at a given
ledger_index.</p>
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The XRP balance of the account (as a string).</p>
</div></li></ul></li></ul></div></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><h3>autofill</h3><div class="tsd-signature tsd-kind-icon">autofill<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>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"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = autofill</span></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/61107e0a/packages/xrpl/src/client/index.ts#L596">packages/xrpl/src/client/index.ts:596</a></li></ul></aside><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 tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>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">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Autofills fields in a transaction. This will set <code>Sequence</code>, <code>Fee</code>,
<code>lastLedgerSequence</code> according to the current state of the server this Client
is connected to. It also converts all X-Addresses to classic addresses and
flags interfaces into numbers.</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>transaction: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A <a href="../modules.html#Transaction">Transaction</a> in JSON format</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> signersCount: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The expected number of signers for this transaction.
Only used for multisigned transactions.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The autofilled transaction.</p>
</div></li></ul></li></ul></div></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>submit</h3><div class="tsd-signature tsd-kind-icon">submit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Transaction" 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"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = submit</span></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/61107e0a/packages/xrpl/src/client/index.ts#L601">packages/xrpl/src/client/index.ts:601</a></li></ul></aside><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 tsd-kind-icon"><span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Transaction" 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">&lt;</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Submits a signed/unsigned transaction.
Steps performed on a transaction:</p>
<ol>
<li>Autofill.</li>
<li>Sign &amp; Encode.</li>
<li>Submit.</li>
</ol>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>RippledError if submit request fails.</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>transaction: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A transaction to autofill, sign &amp; encode, and submit.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> 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><div class="tsd-comment tsd-typography"><div class="lead">
<p>(Optional) Options used to sign and submit a transaction.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, autofill a transaction.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> fail<wbr/>Hard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, and the transaction fails locally, do not retry or relay the transaction to other servers.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A wallet to sign a transaction. It must be provided when submitting an unsigned transaction.</p>
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that contains SubmitResponse.</p>
</div></li></ul></li></ul></div></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>submit<wbr/>And<wbr/>Wait</h3><div class="tsd-signature tsd-kind-icon">submit<wbr/>And<wbr/>Wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Transaction" 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"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = submitAndWait</span></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/61107e0a/packages/xrpl/src/client/index.ts#L605">packages/xrpl/src/client/index.ts:605</a></li></ul></aside><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 tsd-kind-icon"><span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Transaction" 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">&lt;</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<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).
See <a href="https://xrpl.org/reliable-transaction-submission.html">Reliable Transaction Submission</a>.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>transaction: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A transaction to autofill, sign &amp; encode, and submit.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> 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><div class="tsd-comment tsd-typography"><div class="lead">
<p>(Optional) Options used to sign and submit a transaction.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, autofill a transaction.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> fail<wbr/>Hard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, and the transaction fails locally, do not retry or relay the transaction to other servers.</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A wallet to sign a transaction. It must be provided when submitting an unsigned transaction.</p>
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that contains TxResponse, that will return when the transaction has been validated.</p>
</div></li></ul></li></ul></div></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>fund<wbr/>Wallet</h3><div class="tsd-signature tsd-kind-icon">fund<wbr/>Wallet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>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>faucetUrl<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"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol"> = fundWallet</span></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/61107e0a/packages/xrpl/src/client/index.ts#L635">packages/xrpl/src/client/index.ts:635</a></li></ul></aside><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 tsd-kind-icon"><span class="tsd-signature-symbol">(</span>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>faucetUrl<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">&lt;</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">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Generates a random wallet with some amount of XRP (usually 1000 XRP).</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><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">&quot;wss://s.altnet.rippletest.net:51233&quot;</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>
</code></pre>
</dd><dt>throws</dt><dd><p>When either Client isn&#39;t connected or unable to fund wallet address.</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> wallet: <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></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>faucetUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>See below.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> faucet<wbr/>Url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A custom URL for a faucet server. On devnet and
testnet, <code>fundWallet</code> will attempt to determine the correct server
automatically. In other environments, or if you would like to customize the
faucet URL in devnet or testnet, you should provide the URL using this
option.</p>
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>A Wallet on the Testnet or Devnet that contains some amount of XRP,
and that wallet&#39;s balance in XRP.</p>
</div></li></ul></li></ul></div></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><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> fee<wbr/>Cushion</h3><div class="tsd-signature tsd-kind-icon">fee<wbr/>Cushion<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></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/61107e0a/packages/xrpl/src/client/index.ts#L192">packages/xrpl/src/client/index.ts:192</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Factor to multiply estimated fee by to provide a cushion in case the
required fee rises during submission of a transaction. Defaults to 1.2.</p>
</div></div></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><span class="tsd-flag ts-flagReadonly">Readonly</span> max<wbr/>FeeXRP</h3><div class="tsd-signature tsd-kind-icon">max<wbr/>FeeXRP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></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/61107e0a/packages/xrpl/src/client/index.ts#L200">packages/xrpl/src/client/index.ts:200</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maximum transaction cost to allow, in decimal XRP. Must be a string-encoded
number. Defaults to &#39;2&#39;.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group tsd-kind-class"><h2>Network</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="url" class="tsd-anchor"></a><h3>url</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Client.url</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/client/index.ts#L280">packages/xrpl/src/client/index.ts:280</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the url that the client is connected to.</p>
</div><dl class="tsd-comment-tags"><dt>category</dt><dd><p>Network</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The URL of the server this client is connected to.</p>
</div></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>connect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">connect<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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L565">packages/xrpl/src/client/index.ts:565</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Tells the Client instance to connect to its rippled server.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves with a void value when a connection is established.</p>
</div></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>disconnect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">disconnect<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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L575">packages/xrpl/src/client/index.ts:575</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Tells the Client instance to disconnect from it&#39;s rippled server.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves with a void value when a connection is destroyed.</p>
</div></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>is<wbr/>Connected</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Connected<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L589">packages/xrpl/src/client/index.ts:589</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Checks if the Client instance is connected to its rippled server.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Whether the client instance is connected.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a id="request" class="tsd-anchor"></a><h3>request</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</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">&lt;</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/NFTBuyOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/NFTSellOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../modules.html#PathFindRequest" 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">&lt;</span><a href="../interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">&lt;</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">&gt;</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">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L287">packages/xrpl/src/client/index.ts:287</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div><dl class="tsd-comment-tags"><dt>category</dt><dd><p>Network</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L290">packages/xrpl/src/client/index.ts:290</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/AccountCurrenciesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L293">packages/xrpl/src/client/index.ts:293</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/AccountInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L294">packages/xrpl/src/client/index.ts:294</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L295">packages/xrpl/src/client/index.ts:295</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/AccountNFTsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L296">packages/xrpl/src/client/index.ts:296</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L299">packages/xrpl/src/client/index.ts:299</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L300">packages/xrpl/src/client/index.ts:300</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L301">packages/xrpl/src/client/index.ts:301</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L302">packages/xrpl/src/client/index.ts:302</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/ChannelVerifyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L303">packages/xrpl/src/client/index.ts:303</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/DepositAuthorizedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L306">packages/xrpl/src/client/index.ts:306</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/FeeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/GatewayBalancesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L310">packages/xrpl/src/client/index.ts:310</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/LedgerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L311">packages/xrpl/src/client/index.ts:311</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/LedgerClosedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L312">packages/xrpl/src/client/index.ts:312</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/LedgerCurrentRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L313">packages/xrpl/src/client/index.ts:313</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L314">packages/xrpl/src/client/index.ts:314</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/LedgerEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L315">packages/xrpl/src/client/index.ts:315</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/ManifestRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L316">packages/xrpl/src/client/index.ts:316</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/NFTBuyOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NFTBuyOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L317">packages/xrpl/src/client/index.ts:317</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/NFTSellOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NFTSellOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L318">packages/xrpl/src/client/index.ts:318</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/NoRippleCheckRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L319">packages/xrpl/src/client/index.ts:319</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../modules.html#PathFindRequest" class="tsd-signature-type" data-tsd-kind="Type alias">PathFindRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L320">packages/xrpl/src/client/index.ts:320</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/PingRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PingRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L321">packages/xrpl/src/client/index.ts:321</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/RandomRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L322">packages/xrpl/src/client/index.ts:322</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/RipplePathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L325">packages/xrpl/src/client/index.ts:325</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/ServerInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L326">packages/xrpl/src/client/index.ts:326</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/ServerStateRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L327">packages/xrpl/src/client/index.ts:327</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/SubmitRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L328">packages/xrpl/src/client/index.ts:328</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/SubmitMultisignedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L331">packages/xrpl/src/client/index.ts:331</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/SubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L332">packages/xrpl/src/client/index.ts:332</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/UnsubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L333">packages/xrpl/src/client/index.ts:333</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/TransactionEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L336">packages/xrpl/src/client/index.ts:336</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <a href="../interfaces/TxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TxRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L337">packages/xrpl/src/client/index.ts:337</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>R<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BaseRequest</span></h4></li><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BaseResponse</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>r: <span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response from the server.</p>
</div></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><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> clients</h3><div class="tsd-signature tsd-kind-icon">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/61107e0a/packages/xrpl/src/client/BroadcastClient.ts#L9">packages/xrpl/src/client/BroadcastClient.ts:9</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><span class="tsd-flag ts-flagReadonly">Readonly</span> connection</h3><div class="tsd-signature tsd-kind-icon">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/61107e0a/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>prepare<wbr/>Transaction</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>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"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = autofill</span></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/61107e0a/packages/xrpl/src/client/index.ts#L610">packages/xrpl/src/client/index.ts:610</a></li></ul></aside><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 tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>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">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Autofills fields in a transaction. This will set <code>Sequence</code>, <code>Fee</code>,
<code>lastLedgerSequence</code> according to the current state of the server this Client
is connected to. It also converts all X-Addresses to classic addresses and
flags interfaces into numbers.</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>transaction: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A <a href="../modules.html#Transaction">Transaction</a> in JSON format</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> signersCount: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The expected number of signers for this transaction.
Only used for multisigned transactions.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The autofilled transaction.</p>
</div></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> capture<wbr/>Rejection<wbr/>Symbol</h3><div class="tsd-signature tsd-kind-icon">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"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#captureRejectionSymbol">captureRejectionSymbol</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:273</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureRejections" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Rejections</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#captureRejections">captureRejections</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:278</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sets or gets the default captureRejection value for all emitters.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="defaultMaxListeners" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> default<wbr/>Max<wbr/>Listeners</h3><div class="tsd-signature tsd-kind-icon">default<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#defaultMaxListeners">defaultMaxListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:279</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="errorMonitor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error<wbr/>Monitor</h3><div class="tsd-signature tsd-kind-icon">error<wbr/>Monitor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="BroadcastClient.html#errorMonitor" class="tsd-signature-type" data-tsd-kind="Property">errorMonitor</a></div><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#errorMonitor">errorMonitor</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:272</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>This symbol shall be used to install a listener for only monitoring <code>&#39;error&#39;</code>
events. Listeners installed using this symbol are called before the regular
<code>&#39;error&#39;</code> listeners are called.</p>
</div><div><p>Installing a listener using this symbol does not change the behavior once an
<code>&#39;error&#39;</code> event is emitted, therefore the process will still crash if no
regular <code>&#39;error&#39;</code> listener is installed.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a><h3>add<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">add<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>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"> =&gt; </span><span class="tsd-signature-type">void</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:299</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Alias for <code>emitter.on(eventName, listener)</code>.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">emit<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>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">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:555</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<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>
</div><div><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">&#39;events&#39;</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">&#39;event&#39;</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">&#39;Helloooo! first listener&#39;</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">&#39;event&#39;</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">&#39;event&#39;</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">&#39;, &#39;</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">&#39;event&#39;</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">&#39;event&#39;</span><span class="hl-1">, </span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-8">2</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">4</span><span class="hl-1">, </span><span class="hl-8">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>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="eventNames" class="tsd-anchor"></a><h3>event<wbr/>Names</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">event<wbr/>Names<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-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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#eventNames">eventNames</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:614</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<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>
</div><div><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">&#39;events&#39;</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">&#39;foo&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</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">&#39;bar&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</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-9">Symbol</span><span class="hl-1">(</span><span class="hl-7">&#39;symbol&#39;</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">=&gt;</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: [ &#39;foo&#39;, &#39;bar&#39;, Symbol(symbol) ]</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v6.0.0</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <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></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="getMaxListeners" class="tsd-anchor"></a><h3>get<wbr/>Max<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getMaxListeners">getMaxListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:471</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the current max listener value for the <code>EventEmitter</code> which is either
set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="BroadcastClient.html#defaultMaxListeners">defaultMaxListeners</a>.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v1.0.0</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="getMethodNames" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Method<wbr/>Names</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Method<wbr/>Names<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/client/BroadcastClient.ts#L56">packages/xrpl/src/client/BroadcastClient.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets the method names of all the methods of the client.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><div><p>A list of the names of all the methods of the client.</p>
</div></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>listener<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">listener<wbr/>Count<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">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#listenerCount">listenerCount</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:561</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the number of listeners listening to the event named <code>eventName</code>.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v3.2.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event being listened for</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a><h3>listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#listeners">listeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:484</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
</div><div><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">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</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">&#39;someone connected!&#39;</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">&#39;connection&#39;</span><span class="hl-1">)));</span><br/><span class="hl-5">// Prints: [ [Function] ]</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a><h3>off</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">off<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>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"> =&gt; </span><span class="tsd-signature-type">void</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#off">off</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:444</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Alias for <code>emitter.removeListener()</code>.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v10.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></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>on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;connected&quot;</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"> =&gt; </span><span class="tsd-signature-type">void</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></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;disconnected&quot;</span>, listener<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"> =&gt; </span><span class="tsd-signature-type">void</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></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ledgerClosed&quot;</span>, listener<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"> =&gt; </span><span class="tsd-signature-type">void</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></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;validationReceived&quot;</span>, listener<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"> =&gt; </span><span class="tsd-signature-type">void</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></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;transaction&quot;</span>, listener<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"> =&gt; </span><span class="tsd-signature-type">void</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></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;peerStatusChange&quot;</span>, listener<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"> =&gt; </span><span class="tsd-signature-type">void</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></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;consensusPhase&quot;</span>, listener<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"> =&gt; </span><span class="tsd-signature-type">void</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></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;path_find&quot;</span>, listener<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"> =&gt; </span><span class="tsd-signature-type">void</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></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;error&quot;</span>, listener<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"> =&gt; </span><span class="tsd-signature-type">void</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L435">packages/xrpl/src/client/index.ts:435</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><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">&#39;wss://s.altnet.rippletest.net:51233&#39;</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">&#39;transactions&#39;</span><span class="hl-1">, (</span><span class="hl-4">tx</span><span class="hl-1">: </span><span class="hl-9">TransactionStream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</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">&quot;Received Transaction&quot;</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">&#39;subscribe&#39;</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">&#39;transactions_proposed&#39;</span><span class="hl-1">]</span><br/><span class="hl-1">})</span>
</code></pre>
</dd><dt>category</dt><dd><p>Network</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;connected&quot;</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L436">packages/xrpl/src/client/index.ts:436</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;disconnected&quot;</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>code: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L437">packages/xrpl/src/client/index.ts:437</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;ledgerClosed&quot;</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ledger: <a href="../interfaces/LedgerStream.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerStream</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L441">packages/xrpl/src/client/index.ts:441</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;validationReceived&quot;</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>validation: <a href="../interfaces/ValidationStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationStream</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L445">packages/xrpl/src/client/index.ts:445</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;transaction&quot;</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tx: <a href="../interfaces/TransactionStream.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionStream</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L449">packages/xrpl/src/client/index.ts:449</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;peerStatusChange&quot;</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>status: <a href="../interfaces/PeerStatusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerStatusStream</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L453">packages/xrpl/src/client/index.ts:453</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;consensusPhase&quot;</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>phase: <a href="../interfaces/ConsensusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ConsensusStream</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L457">packages/xrpl/src/client/index.ts:457</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;path_find&quot;</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <a href="../interfaces/PathFindStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindStream</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L459">packages/xrpl/src/client/index.ts:459</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event handler for subscription streams.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">&quot;error&quot;</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to run on event.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>err: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><div><p>This, because it inherits from EventEmitter.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a><h3>once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">once<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>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"> =&gt; </span><span class="tsd-signature-type">void</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:359</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<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>
</div><div><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">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</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">&#39;Ah, we have our first user!&#39;</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">&#39;foo&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</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">&#39;a&#39;</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">&#39;foo&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</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">&#39;b&#39;</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">&#39;foo&#39;</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>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.3.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event.</p>
</div></div></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The callback function</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prependListener" class="tsd-anchor"></a><h3>prepend<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepend<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>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"> =&gt; </span><span class="tsd-signature-type">void</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:579</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Adds the <code>listener</code> function to the <em>beginning</em> of the listeners array for the
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>
</div><div><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">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</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">&#39;someone connected!&#39;</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>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v6.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event.</p>
</div></div></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The callback function</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prependOnceListener" class="tsd-anchor"></a><h3>prepend<wbr/>Once<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<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>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"> =&gt; </span><span class="tsd-signature-type">void</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:595</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<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>
</div><div><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">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-4">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</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">&#39;Ah, we have our first user!&#39;</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>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v6.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event.</p>
</div></div></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The callback function</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a><h3>raw<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">raw<wbr/>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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#rawListeners">rawListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:514</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<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>
</div><div><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">&#39;log&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</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">&#39;log once&#39;</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">&#39;log&#39;</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-8">0</span><span class="hl-1">];</span><br/><br/><span class="hl-5">// Logs &quot;log once&quot; 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 &quot;log once&quot; 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">&#39;log&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</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">&#39;log persistently&#39;</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">&#39;log&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Logs &quot;log persistently&quot; twice</span><br/><span class="hl-4">newListeners</span><span class="hl-1">[</span><span class="hl-8">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">&#39;log&#39;</span><span class="hl-1">);</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v9.4.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a><h3>remove<wbr/>All<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">remove<wbr/>All<wbr/>Listeners<span class="tsd-signature-symbol">(</span>event<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><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#removeAllListeners">removeAllListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:455</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
</div><div><p>It is bad practice to remove listeners added elsewhere in the code,
particularly when the <code>EventEmitter</code> instance was created by some other
component or module (e.g. sockets or file streams).</p>
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a><h3>remove<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">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>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"> =&gt; </span><span class="tsd-signature-type">void</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:439</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
</div><div><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">=&gt;</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">&#39;someone connected!&#39;</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">&#39;connection&#39;</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">&#39;connection&#39;</span><span class="hl-1">, </span><span class="hl-4">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
listener array for the specified <code>eventName</code>, then <code>removeListener()</code> must be
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">=&gt;</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">&#39;A&#39;</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">&#39;event&#39;</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">=&gt;</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">&#39;B&#39;</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">&#39;event&#39;</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">&#39;event&#39;</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">&#39;event&#39;</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">&#39;event&#39;</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// 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
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
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(&#39;ping&#39;)</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">&#39;pong&#39;</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">&#39;ping&#39;</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">&#39;ping&#39;</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">&#39;ping&#39;</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">&#39;ping&#39;</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">&#39;ping&#39;</span><span class="hl-1">);</span>
</code></pre>
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></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>request<wbr/>All</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</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">&lt;</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">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</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">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</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">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</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">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</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">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</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">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</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">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L475">packages/xrpl/src/client/index.ts:475</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes multiple paged requests to the client to return a given number of
resources. Multiple paged requests will be made until the <code>limit</code>
number of resources is reached (if no <code>limit</code> is provided, a single request
will be made).</p>
</div><div><p>If the command is unknown, an additional <code>collect</code> property is required to
know which response key contains the array of resources.</p>
<p>NOTE: This command is used by existing methods and is not recommended for
general use. Instead, use rippled&#39;s built-in pagination and make multiple
requests as needed.</p>
</div><dl class="tsd-comment-tags"><dt>category</dt><dd><p>Network</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>The array of all responses.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L478">packages/xrpl/src/client/index.ts:478</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes multiple paged requests to the client to return a given number of
resources. Multiple paged requests will be made until the <code>limit</code>
number of resources is reached (if no <code>limit</code> is provided, a single request
will be made).</p>
</div><div><p>If the command is unknown, an additional <code>collect</code> property is required to
know which response key contains the array of resources.</p>
<p>NOTE: This command is used by existing methods and is not recommended for
general use. Instead, use rippled&#39;s built-in pagination and make multiple
requests as needed.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>The array of all responses.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L481">packages/xrpl/src/client/index.ts:481</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes multiple paged requests to the client to return a given number of
resources. Multiple paged requests will be made until the <code>limit</code>
number of resources is reached (if no <code>limit</code> is provided, a single request
will be made).</p>
</div><div><p>If the command is unknown, an additional <code>collect</code> property is required to
know which response key contains the array of resources.</p>
<p>NOTE: This command is used by existing methods and is not recommended for
general use. Instead, use rippled&#39;s built-in pagination and make multiple
requests as needed.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>The array of all responses.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L484">packages/xrpl/src/client/index.ts:484</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes multiple paged requests to the client to return a given number of
resources. Multiple paged requests will be made until the <code>limit</code>
number of resources is reached (if no <code>limit</code> is provided, a single request
will be made).</p>
</div><div><p>If the command is unknown, an additional <code>collect</code> property is required to
know which response key contains the array of resources.</p>
<p>NOTE: This command is used by existing methods and is not recommended for
general use. Instead, use rippled&#39;s built-in pagination and make multiple
requests as needed.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>The array of all responses.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L487">packages/xrpl/src/client/index.ts:487</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes multiple paged requests to the client to return a given number of
resources. Multiple paged requests will be made until the <code>limit</code>
number of resources is reached (if no <code>limit</code> is provided, a single request
will be made).</p>
</div><div><p>If the command is unknown, an additional <code>collect</code> property is required to
know which response key contains the array of resources.</p>
<p>NOTE: This command is used by existing methods and is not recommended for
general use. Instead, use rippled&#39;s built-in pagination and make multiple
requests as needed.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>The array of all responses.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L488">packages/xrpl/src/client/index.ts:488</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes multiple paged requests to the client to return a given number of
resources. Multiple paged requests will be made until the <code>limit</code>
number of resources is reached (if no <code>limit</code> is provided, a single request
will be made).</p>
</div><div><p>If the command is unknown, an additional <code>collect</code> property is required to
know which response key contains the array of resources.</p>
<p>NOTE: This command is used by existing methods and is not recommended for
general use. Instead, use rippled&#39;s built-in pagination and make multiple
requests as needed.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>The array of all responses.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes multiple paged requests to the client to return a given number of
resources. Multiple paged requests will be made until the <code>limit</code>
number of resources is reached (if no <code>limit</code> is provided, a single request
will be made).</p>
</div><div><p>If the command is unknown, an additional <code>collect</code> property is required to
know which response key contains the array of resources.</p>
<p>NOTE: This command is used by existing methods and is not recommended for
general use. Instead, use rippled&#39;s built-in pagination and make multiple
requests as needed.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><div><p>The array of all responses.</p>
</div></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>request<wbr/>Next<wbr/>Page</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a>, resp<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">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">&lt;</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L369">packages/xrpl/src/client/index.ts:369</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Requests the next page of data.</p>
</div><dl class="tsd-comment-tags"><dt>category</dt><dd><p>Network</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Request to send.</p>
</div></div></li><li><h5>resp: <a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Response with the marker to use in the request.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response with the next page of data.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L373">packages/xrpl/src/client/index.ts:373</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Requests the next page of data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Request to send.</p>
</div></div></li><li><h5>resp: <a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Response with the marker to use in the request.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response with the next page of data.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L377">packages/xrpl/src/client/index.ts:377</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Requests the next page of data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Request to send.</p>
</div></div></li><li><h5>resp: <a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Response with the marker to use in the request.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response with the next page of data.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L381">packages/xrpl/src/client/index.ts:381</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Requests the next page of data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Request to send.</p>
</div></div></li><li><h5>resp: <a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Response with the marker to use in the request.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response with the next page of data.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L385">packages/xrpl/src/client/index.ts:385</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Requests the next page of data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Request to send.</p>
</div></div></li><li><h5>resp: <a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Response with the marker to use in the request.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response with the next page of data.</p>
</div></li><li class="tsd-description"><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/61107e0a/packages/xrpl/src/client/index.ts#L389">packages/xrpl/src/client/index.ts:389</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Requests the next page of data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Request to send.</p>
</div></div></li><li><h5>resp: <a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Response with the marker to use in the request.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The response with the next page of data.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="setMaxListeners" class="tsd-anchor"></a><h3>set<wbr/>Max<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">(</span>n<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><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#setMaxListeners">setMaxListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:465</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>By default <code>EventEmitter</code>s will print a warning if more than <code>10</code> listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The <code>emitter.setMaxListeners()</code> method allows the limit to be
modified for this specific <code>EventEmitter</code> instance. The value can be set to<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
</div><div><p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.3.5</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr/>Event<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">get<wbr/>Event<wbr/>Listeners<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMEventTarget</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventEmitter</span>, name<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getEventListeners">getEventListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:262</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
</div><div><p>For <code>EventEmitter</code>s this behaves exactly the same as calling <code>.listeners</code> on
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">&#39;events&#39;</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">=&gt;</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">&#39;Events are fun&#39;</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">&#39;foo&#39;</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">&#39;foo&#39;</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">=&gt;</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">&#39;Events are fun&#39;</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">&#39;foo&#39;</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">&#39;foo&#39;</span><span class="hl-1">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-1">}</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v15.2.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">DOMEventTarget</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventEmitter</span></h5></li><li><h5>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="listenerCount-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> listener<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#listenerCount-1">listenerCount</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:234</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
</div><div><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">&#39;events&#39;</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">&#39;event&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</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">&#39;event&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</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">&#39;event&#39;</span><span class="hl-1">));</span><br/><span class="hl-5">// Prints: 2</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.12</p>
</dd><dt>deprecated</dt><dd><p>Since v3.2.0 - Use <code>listenerCount</code> instead.</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The emitter to query</p>
</div></div></li><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The event name</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="on-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on-1">on</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:217</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>```js
const { on, EventEmitter } = require(&#39;events&#39;);</p>
</div><div><p>(async () =&gt; {
const ee = new EventEmitter();</p>
<p> // Emit later on
process.nextTick(() =&gt; {
ee.emit(&#39;foo&#39;, &#39;bar&#39;);
ee.emit(&#39;foo&#39;, 42);
});</p>
<p> for await (const event of on(ee, &#39;foo&#39;)) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints [&#39;bar&#39;] [42]
}
// Unreachable here
})();</p>
<pre><code><br/><span class="hl-4">Returns</span><span class="hl-1"> </span><span class="hl-4">an</span><span class="hl-1"> </span><span class="hl-7">`AsyncIterator`</span><span class="hl-1"> </span><span class="hl-4">that</span><span class="hl-1"> </span><span class="hl-4">iterates</span><span class="hl-1"> </span><span class="hl-7">`eventName`</span><span class="hl-1"> </span><span class="hl-4">events</span><span class="hl-1">. </span><span class="hl-4">It</span><span class="hl-1"> </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-6">throw</span><br/><span class="hl-6">if</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-7">`EventEmitter`</span><span class="hl-1"> </span><span class="hl-4">emits</span><span class="hl-1"> </span><span class="hl-7">`&#39;error&#39;`</span><span class="hl-1">. </span><span class="hl-4">It</span><span class="hl-1"> </span><span class="hl-4">removes</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-4">listeners</span><span class="hl-1"> </span><span class="hl-4">when</span><br/><span class="hl-4">exiting</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">loop</span><span class="hl-1">. </span><span class="hl-4">The</span><span class="hl-1"> </span><span class="hl-7">`value`</span><span class="hl-1"> </span><span class="hl-4">returned</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-4">each</span><span class="hl-1"> </span><span class="hl-4">iteration</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">an</span><span class="hl-1"> </span><span class="hl-4">array</span><br/><span class="hl-4">composed</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">emitted</span><span class="hl-1"> </span><span class="hl-4">event</span><span class="hl-1"> </span><span class="hl-0">arguments</span><span class="hl-1">.</span><br/><br/><span class="hl-4">An</span><span class="hl-1"> </span><span class="hl-7">`AbortSignal`</span><span class="hl-1"> </span><span class="hl-4">can</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">used</span><span class="hl-1"> </span><span class="hl-4">to</span><span class="hl-1"> </span><span class="hl-4">cancel</span><span class="hl-1"> </span><span class="hl-4">waiting</span><span class="hl-1"> </span><span class="hl-4">on</span><span class="hl-1"> </span><span class="hl-10">events</span><span class="hl-1">:</span><br/><br/><span class="hl-7">```js</span><br/><span class="hl-7">const { on, EventEmitter } = require(&#39;events&#39;);</span><br/><span class="hl-7">const ac = new AbortController();</span><br/><br/><span class="hl-7">(async () =&gt; {</span><br/><span class="hl-7"> const ee = new EventEmitter();</span><br/><br/><span class="hl-7"> // Emit later on</span><br/><span class="hl-7"> process.nextTick(() =&gt; {</span><br/><span class="hl-7"> ee.emit(&#39;foo&#39;, &#39;bar&#39;);</span><br/><span class="hl-7"> ee.emit(&#39;foo&#39;, 42);</span><br/><span class="hl-7"> });</span><br/><br/><span class="hl-7"> for await (const event of on(ee, &#39;foo&#39;, { signal: ac.signal })) {</span><br/><span class="hl-7"> // The execution of this inner block is synchronous and it</span><br/><span class="hl-7"> // processes one event at a time (even with await). Do not use</span><br/><span class="hl-7"> // if concurrent execution is required.</span><br/><span class="hl-7"> console.log(event); // prints [&#39;bar&#39;] [42]</span><br/><span class="hl-7"> }</span><br/><span class="hl-7"> // Unreachable here</span><br/><span class="hl-7">})();</span><br/><br/><span class="hl-7">process.nextTick(() =&gt; ac.abort());</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v13.6.0, v12.16.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event being listened for</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">StaticEventEmitterOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>that iterates <code>eventName</code> events emitted by the <code>emitter</code></p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="once-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeEventTarget</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>, 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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMEventTarget</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#once-1">once</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:157</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a <code>Promise</code> that is fulfilled when the <code>EventEmitter</code> emits the given
event or that is rejected if the <code>EventEmitter</code> emits <code>&#39;error&#39;</code> while waiting.
The <code>Promise</code> will resolve with an array of all the arguments emitted to the
given event.</p>
</div><div><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>&#39;error&#39;</code> event
semantics and does not listen to the <code>&#39;error&#39;</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">&#39;events&#39;</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">=&gt;</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">&#39;myevent&#39;</span><span class="hl-1">, </span><span class="hl-8">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">&#39;myevent&#39;</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-9">Error</span><span class="hl-1">(</span><span class="hl-7">&#39;kaboom&#39;</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">=&gt;</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">&#39;error&#39;</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">&#39;myevent&#39;</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">&#39;error happened&#39;</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>
</code></pre>
<p>The special handling of the <code>&#39;error&#39;</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
&#39;<code>error&#39;</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">&#39;events&#39;</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">&#39;error&#39;</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">=&gt;</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">&#39;ok&#39;</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">=&gt;</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">&#39;error&#39;</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">&#39;error&#39;</span><span class="hl-1">, </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-9">Error</span><span class="hl-1">(</span><span class="hl-7">&#39;boom&#39;</span><span class="hl-1">));</span><br/><br/><span class="hl-5">// 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">&#39;events&#39;</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">&#39;event emitted!&#39;</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">&#39;AbortError&#39;</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">&#39;Waiting for the event was canceled!&#39;</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">&#39;There was an error&#39;</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">&#39;foo&#39;</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">&#39;foo&#39;</span><span class="hl-1">); </span><span class="hl-5">// Prints: Waiting for the event was canceled!</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v11.13.0, v10.16.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">NodeEventTarget</span></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">StaticEventEmitterOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#once-1">once</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:158</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">DOMEventTarget</span></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">StaticEventEmitterOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="BroadcastClient.html" class="tsd-kind-icon">Broadcast<wbr/>Client</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="BroadcastClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#autofill" class="tsd-kind-icon">autofill</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BroadcastClient.html#clients" class="tsd-kind-icon">clients</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#connection" class="tsd-kind-icon">connection</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#feeCushion" class="tsd-kind-icon">fee<wbr/>Cushion</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#fundWallet" class="tsd-kind-icon">fund<wbr/>Wallet</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getBalances" class="tsd-kind-icon">get<wbr/>Balances</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getLedgerIndex" class="tsd-kind-icon">get<wbr/>Ledger<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getOrderbook" class="tsd-kind-icon">get<wbr/>Orderbook</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getXrpBalance" class="tsd-kind-icon">get<wbr/>Xrp<wbr/>Balance</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#maxFeeXRP" class="tsd-kind-icon">max<wbr/>FeeXRP</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#prepareTransaction" class="tsd-kind-icon">prepare<wbr/>Transaction</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#submit" class="tsd-kind-icon">submit</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#submitAndWait" class="tsd-kind-icon">submit<wbr/>And<wbr/>Wait</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#disconnect" class="tsd-kind-icon">disconnect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BroadcastClient.html#getMethodNames" class="tsd-kind-icon">get<wbr/>Method<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#isConnected" class="tsd-kind-icon">is<wbr/>Connected</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="BroadcastClient.html#request" class="tsd-kind-icon">request</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#requestAll" class="tsd-kind-icon">request<wbr/>All</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#requestNextPage" class="tsd-kind-icon">request<wbr/>Next<wbr/>Page</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#getEventListeners" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#on-1" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="BroadcastClient.html#once-1" class="tsd-kind-icon">once</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink