mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-07 06:15:49 +00:00
2086 lines
310 KiB
HTML
2086 lines
310 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><script src="https://cmp.osano.com/AzyjT6TIZMlgyLyy8/ad2447d5-f101-40df-b92e-d6452b5ecac0/osano.js"></script><script>
|
||
(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
|
||
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
|
||
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
|
||
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
|
||
})(window,document,'script','dataLayer','GTM-M7HKJJ3');
|
||
</script><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><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M7HKJJ3" height=0 width=0 style="display:none;visibility:hidden"></iframe></noscript><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
||
<div class="tsd-toolbar-contents container">
|
||
<div class="table-cell" id="tsd-search" data-base="..">
|
||
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
||
<div class="field">
|
||
<div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
||
<div class="container container-main">
|
||
<div class="col-8 col-content">
|
||
<div class="tsd-page-title">
|
||
<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>
|
||
<section class="tsd-panel tsd-comment">
|
||
<div class="tsd-comment tsd-typography"><p>Client that can rely on multiple different servers.</p>
|
||
|
||
<h3>Deprecated</h3><p>since version 2.2.0.
|
||
Will be deleted in version 3.0.0.</p>
|
||
<p>Currently this implementation does not provide better reliability.
|
||
To get better reliability, implement reconnect/error handling logic
|
||
and choose a reliable endpoint.</p>
|
||
<p>If you need the ability to fall-back to different endpoints, consider
|
||
using <a href="https://github.com/XRPL-Labs/xrpl-client/">xrpl-client</a></p>
|
||
</div></section>
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h4>Hierarchy</h4>
|
||
<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><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/BroadcastClient.ts#L18">packages/xrpl/src/client/BroadcastClient.ts:18</a></li></ul></aside>
|
||
<section class="tsd-panel-group tsd-index-group">
|
||
<section class="tsd-panel tsd-index-panel">
|
||
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
||
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
||
<div class="tsd-accordion-details">
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Constructor</h3>
|
||
<div class="tsd-index-list"><a href="BroadcastClient.html#constructor" class="tsd-index-link deprecated tsd-kind-constructor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-512-text"></path></svg><span>constructor</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Abstraction</h3>
|
||
<div class="tsd-index-list"><a href="BroadcastClient.html#getBalances" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>get<wbr/>Balances</span></a>
|
||
<a href="BroadcastClient.html#getLedgerIndex" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>get<wbr/>Ledger<wbr/>Index</span></a>
|
||
<a href="BroadcastClient.html#getOrderbook" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>get<wbr/>Orderbook</span></a>
|
||
<a href="BroadcastClient.html#getXrpBalance" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>get<wbr/>Xrp<wbr/>Balance</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Core</h3>
|
||
<div class="tsd-index-list"><a href="BroadcastClient.html#autofill" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>autofill</span></a>
|
||
<a href="BroadcastClient.html#submit" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>submit</span></a>
|
||
<a href="BroadcastClient.html#submitAndWait" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>submit<wbr/>And<wbr/>Wait</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Faucet</h3>
|
||
<div class="tsd-index-list"><a href="BroadcastClient.html#fundWallet" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>fund<wbr/>Wallet</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Fee</h3>
|
||
<div class="tsd-index-list"><a href="BroadcastClient.html#feeCushion" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>fee<wbr/>Cushion</span></a>
|
||
<a href="BroadcastClient.html#maxFeeXRP" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>max<wbr/>FeeXRP</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Network</h3>
|
||
<div class="tsd-index-list"><a href="BroadcastClient.html#url" class="tsd-index-link deprecated tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>url</span></a>
|
||
<a href="BroadcastClient.html#connect" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>connect</span></a>
|
||
<a href="BroadcastClient.html#disconnect" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>disconnect</span></a>
|
||
<a href="BroadcastClient.html#isConnected" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Connected</span></a>
|
||
<a href="BroadcastClient.html#on" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>on</span></a>
|
||
<a href="BroadcastClient.html#request" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>request</span></a>
|
||
<a href="BroadcastClient.html#requestAll" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>request<wbr/>All</span></a>
|
||
<a href="BroadcastClient.html#requestNextPage" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>request<wbr/>Next<wbr/>Page</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Other</h3>
|
||
<div class="tsd-index-list"><a href="BroadcastClient.html#clients" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>clients</span></a>
|
||
<a href="BroadcastClient.html#connection" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>connection</span></a>
|
||
<a href="BroadcastClient.html#prepareTransaction" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Transaction</span></a>
|
||
<a href="BroadcastClient.html#captureRejectionSymbol" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>capture<wbr/>Rejection<wbr/>Symbol</span></a>
|
||
<a href="BroadcastClient.html#captureRejections" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>capture<wbr/>Rejections</span></a>
|
||
<a href="BroadcastClient.html#defaultMaxListeners" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>default<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="BroadcastClient.html#errorMonitor" class="tsd-index-link deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>error<wbr/>Monitor</span></a>
|
||
<a href="BroadcastClient.html#addListener" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Listener</span></a>
|
||
<a href="BroadcastClient.html#emit" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>emit</span></a>
|
||
<a href="BroadcastClient.html#eventNames" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>event<wbr/>Names</span></a>
|
||
<a href="BroadcastClient.html#getMaxListeners" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="BroadcastClient.html#getMethodNames" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Method<wbr/>Names</span></a>
|
||
<a href="BroadcastClient.html#listenerCount" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>listener<wbr/>Count</span></a>
|
||
<a href="BroadcastClient.html#listeners" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>listeners</span></a>
|
||
<a href="BroadcastClient.html#off" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>off</span></a>
|
||
<a href="BroadcastClient.html#once" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>once</span></a>
|
||
<a href="BroadcastClient.html#prependListener" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>prepend<wbr/>Listener</span></a>
|
||
<a href="BroadcastClient.html#prependOnceListener" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a>
|
||
<a href="BroadcastClient.html#rawListeners" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>raw<wbr/>Listeners</span></a>
|
||
<a href="BroadcastClient.html#removeAllListeners" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a>
|
||
<a href="BroadcastClient.html#removeListener" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove<wbr/>Listener</span></a>
|
||
<a href="BroadcastClient.html#setMaxListeners" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="BroadcastClient.html#listenerCount-2" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>listener<wbr/>Count</span></a>
|
||
<a href="BroadcastClient.html#on-11" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>on</span></a>
|
||
<a href="BroadcastClient.html#once-2" class="tsd-index-link deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>once</span></a>
|
||
</div></section></div></details></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"><a id="constructor" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="constructor.new_BroadcastClient">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><a href="#constructor.new_BroadcastClient" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Creates a new BroadcastClient.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>servers: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>An array of names of servers.</p>
|
||
</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"><p>Options for the clients.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Overrides <a href="Client.html">Client</a>.<a href="Client.html#constructor">constructor</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/BroadcastClient.ts#L28">packages/xrpl/src/client/BroadcastClient.ts:28</a></li></ul></aside></li></ul></section></section>
|
||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||
<h2>Abstraction</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="getBalances" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Balances</span><a href="#getBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">get<wbr/>Balances<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getBalances</span></div>
|
||
<div class="tsd-type-declaration">
|
||
<h4>Type declaration</h4>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||
<li class="tsd-signature" id="getBalances.__type-4.__type-5"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li>
|
||
<li>
|
||
<h5>address: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> ledger_<wbr/>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> ledger_<wbr/>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> peer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>issuer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getBalances">getBalances</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L625">packages/xrpl/src/client/index.ts:625</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="getLedgerIndex" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Ledger<wbr/>Index</span><a href="#getLedgerIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">get<wbr/>Ledger<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getLedgerIndex</span></div>
|
||
<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-property">
|
||
<li class="tsd-signature" id="getLedgerIndex.__type-6.__type-7"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getLedgerIndex">getLedgerIndex</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L635">packages/xrpl/src/client/index.ts:635</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="getOrderbook" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Orderbook</span><a href="#getOrderbook" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">get<wbr/>Orderbook<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getOrderbook</span></div>
|
||
<div class="tsd-type-declaration">
|
||
<h4>Type declaration</h4>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||
<li class="tsd-signature" id="getOrderbook.__type-8.__type-9"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, takerPays<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, takerGets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakerAmount</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li>
|
||
<li>
|
||
<h5>takerPays: <span class="tsd-signature-type">TakerAmount</span></h5></li>
|
||
<li>
|
||
<h5>takerGets: <span class="tsd-signature-type">TakerAmount</span></h5></li>
|
||
<li>
|
||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span> </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> ledger_<wbr/>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> ledger_<wbr/>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> taker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>buy<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>sell<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#getOrderbook">getOrderbook</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L630">packages/xrpl/src/client/index.ts:630</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="getXrpBalance" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Xrp<wbr/>Balance</span><a href="#getXrpBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">get<wbr/>Xrp<wbr/>Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = getXrpBalance</span></div>
|
||
<div class="tsd-type-declaration">
|
||
<h4>Type declaration</h4>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||
<li class="tsd-signature" id="getXrpBalance.__type-10.__type-11"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li>
|
||
<li>
|
||
<h5>address: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5>options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> ledger_<wbr/>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> ledger_<wbr/>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerIndex</span></h5></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L620">packages/xrpl/src/client/index.ts:620</a></li></ul></aside></section></section>
|
||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||
<h2>Core</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="autofill" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">autofill</span><a href="#autofill" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">autofill<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, signersCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = autofill</span></div>
|
||
<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-property">
|
||
<li class="tsd-signature" id="autofill.__type.__type-1"><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, signersCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<section class="tsd-panel tsd-type-parameters">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameters">
|
||
<li>
|
||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li>
|
||
<li>
|
||
<h5>transaction: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> signersCount: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#autofill">autofill</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L601">packages/xrpl/src/client/index.ts:601</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="submit" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">submit</span><a href="#submit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">submit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submit</span></div>
|
||
<div class="tsd-type-declaration">
|
||
<h4>Type declaration</h4>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||
<li class="tsd-signature" id="submit.__type-14.__type-15"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li>
|
||
<li>
|
||
<h5>transaction: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> fail<wbr/>Hard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h5></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L606">packages/xrpl/src/client/index.ts:606</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="submitAndWait" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">submit<wbr/>And<wbr/>Wait</span><a href="#submitAndWait" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">submit<wbr/>And<wbr/>Wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = submitAndWait</span></div>
|
||
<div class="tsd-type-declaration">
|
||
<h4>Type declaration</h4>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||
<li class="tsd-signature" id="submitAndWait.__type-16.__type-17"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li>
|
||
<li>
|
||
<h5>transaction: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> opts: <span class="tsd-signature-symbol">{ </span><br/><span> </span>autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>failHard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> autofill<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> fail<wbr/>Hard<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> wallet<span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h5></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L610">packages/xrpl/src/client/index.ts:610</a></li></ul></aside></section></section>
|
||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||
<h2>Faucet</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fundWallet" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">fund<wbr/>Wallet</span><a href="#fundWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">fund<wbr/>Wallet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>amount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>faucetPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = fundWallet</span></div>
|
||
<div class="tsd-type-declaration">
|
||
<h4>Type declaration</h4>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||
<li class="tsd-signature" id="fundWallet.__type-2.__type-3"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, wallet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>amount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>faucetPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-symbol">{ </span><br/><span> </span>amount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>faucetHost<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>faucetPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> amount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> faucet<wbr/>Host<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li>
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> faucet<wbr/>Path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>wallet<span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#fundWallet">fundWallet</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L640">packages/xrpl/src/client/index.ts:640</a></li></ul></aside></section></section>
|
||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||
<h2>Fee</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="feeCushion" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">fee<wbr/>Cushion</span><a href="#feeCushion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">fee<wbr/>Cushion<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||
<div class="tsd-comment tsd-typography"><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><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/1a1d8087/packages/xrpl/src/client/index.ts#L193">packages/xrpl/src/client/index.ts:193</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="maxFeeXRP" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">max<wbr/>FeeXRP</span><a href="#maxFeeXRP" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">max<wbr/>FeeXRP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Maximum transaction cost to allow, in decimal XRP. Must be a string-encoded
|
||
number. Defaults to '2'.</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#maxFeeXRP">maxFeeXRP</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L201">packages/xrpl/src/client/index.ts:201</a></li></ul></aside></section></section>
|
||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||
<h2>Network</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="url" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">url</span><a href="#url" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature" id="url.url-1"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Get the url that the client is connected to.</p>
|
||
|
||
<h3>Returns</h3><p>The URL of the server this client is connected to.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Client.url</p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L281">packages/xrpl/src/client/index.ts:281</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="connect" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-anchor-link" id="connect.connect-1">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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#connect.connect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Tells the Client instance to connect to its rippled server.</p>
|
||
|
||
<h3>Returns</h3><p>A promise that resolves with a void value when a connection is established.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L570">packages/xrpl/src/client/index.ts:570</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="disconnect" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">disconnect</span><a href="#disconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-anchor-link" id="disconnect.disconnect-1">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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#disconnect.disconnect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Tells the Client instance to disconnect from it's rippled server.</p>
|
||
|
||
<h3>Returns</h3><p>A promise that resolves with a void value when a connection is destroyed.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L580">packages/xrpl/src/client/index.ts:580</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isConnected" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">is<wbr/>Connected</span><a href="#isConnected" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-anchor-link" id="isConnected.isConnected-1">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><a href="#isConnected.isConnected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Checks if the Client instance is connected to its rippled server.</p>
|
||
|
||
<h3>Returns</h3><p>Whether the client instance is connected.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#isConnected">isConnected</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L594">packages/xrpl/src/client/index.ts:594</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="on" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-1">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"connected"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Example</h3><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">api</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">'wss://s.altnet.rippletest.net:51233'</span><span class="hl-1">)</span><br/><br/><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">'transactions'</span><span class="hl-1">, (</span><span class="hl-0">tx</span><span class="hl-1">: </span><span class="hl-7">TransactionStream</span><span class="hl-1">) </span><span class="hl-2">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">"Received Transaction"</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">tx</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">response</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">request</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">'subscribe'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">streams:</span><span class="hl-1"> [</span><span class="hl-5">'transactions_proposed'</span><span class="hl-1">]</span><br/><span class="hl-1">})</span>
|
||
</code></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"connected"</span></h5></li>
|
||
<li>
|
||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L436">packages/xrpl/src/client/index.ts:436</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-2">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"disconnected"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"disconnected"</span></h5></li>
|
||
<li>
|
||
<h5>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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>code: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L437">packages/xrpl/src/client/index.ts:437</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-3">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ledgerClosed"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>ledger<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerStream.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"ledgerClosed"</span></h5></li>
|
||
<li>
|
||
<h5>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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>ledger: <a href="../interfaces/LedgerStream.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerStream</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L438">packages/xrpl/src/client/index.ts:438</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-4">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"validationReceived"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>validation<span class="tsd-signature-symbol">: </span><a href="../interfaces/ValidationStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"validationReceived"</span></h5></li>
|
||
<li>
|
||
<h5>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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>validation: <a href="../interfaces/ValidationStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationStream</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L442">packages/xrpl/src/client/index.ts:442</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-5">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"transaction"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../interfaces/TransactionStream.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-5" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"transaction"</span></h5></li>
|
||
<li>
|
||
<h5>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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>tx: <a href="../interfaces/TransactionStream.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionStream</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L446">packages/xrpl/src/client/index.ts:446</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-6">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"peerStatusChange"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">: </span><a href="../interfaces/PeerStatusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerStatusStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-6" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"peerStatusChange"</span></h5></li>
|
||
<li>
|
||
<h5>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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>status: <a href="../interfaces/PeerStatusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerStatusStream</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L450">packages/xrpl/src/client/index.ts:450</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-7">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"consensusPhase"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>phase<span class="tsd-signature-symbol">: </span><a href="../interfaces/ConsensusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ConsensusStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-7" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"consensusPhase"</span></h5></li>
|
||
<li>
|
||
<h5>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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>phase: <a href="../interfaces/ConsensusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ConsensusStream</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L454">packages/xrpl/src/client/index.ts:454</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-8">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"manifestReceived"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>manifest<span class="tsd-signature-symbol">: </span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-8" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"manifestReceived"</span></h5></li>
|
||
<li>
|
||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>manifest<span class="tsd-signature-symbol">: </span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>manifest<span class="tsd-signature-symbol">: </span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>manifest: <a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L458">packages/xrpl/src/client/index.ts:458</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-9">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"path_find"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><a href="../interfaces/PathFindStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-9" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"path_find"</span></h5></li>
|
||
<li>
|
||
<h5>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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>path: <a href="../interfaces/PathFindStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindStream</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L462">packages/xrpl/src/client/index.ts:462</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-10">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#on.on-10" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
|
||
|
||
<h3>Returns</h3><p>This, because it inherits from EventEmitter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">"error"</span></h5></li>
|
||
<li>
|
||
<h5>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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>err: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L464">packages/xrpl/src/client/index.ts:464</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="request" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-1">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"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L288">packages/xrpl/src/client/index.ts:288</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-2">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountCurrenciesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/AccountCurrenciesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L291">packages/xrpl/src/client/index.ts:291</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-3">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/AccountInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L294">packages/xrpl/src/client/index.ts:294</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-4">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L295">packages/xrpl/src/client/index.ts:295</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-5">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountNFTsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-5" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/AccountNFTsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountNFTsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L296">packages/xrpl/src/client/index.ts:296</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-6">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-6" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L297">packages/xrpl/src/client/index.ts:297</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-7">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-7" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L300">packages/xrpl/src/client/index.ts:300</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-8">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-8" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L301">packages/xrpl/src/client/index.ts:301</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-9">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-9" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L302">packages/xrpl/src/client/index.ts:302</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-10">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ChannelVerifyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-10" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/ChannelVerifyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L303">packages/xrpl/src/client/index.ts:303</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-11">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/DepositAuthorizedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-11" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/DepositAuthorizedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L304">packages/xrpl/src/client/index.ts:304</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-12">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/FeeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-12" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/FeeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-13">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/GatewayBalancesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-13" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/GatewayBalancesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L308">packages/xrpl/src/client/index.ts:308</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-14">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-14" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/LedgerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L311">packages/xrpl/src/client/index.ts:311</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-15">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerClosedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-15" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/LedgerClosedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L312">packages/xrpl/src/client/index.ts:312</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-16">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerCurrentRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-16" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/LedgerCurrentRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L313">packages/xrpl/src/client/index.ts:313</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-17">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-17" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L314">packages/xrpl/src/client/index.ts:314</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-18">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-18" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/LedgerEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L315">packages/xrpl/src/client/index.ts:315</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-19">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ManifestRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-19" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/ManifestRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L316">packages/xrpl/src/client/index.ts:316</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-20">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NFTBuyOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTBuyOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-20" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/NFTBuyOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTBuyOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTBuyOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L317">packages/xrpl/src/client/index.ts:317</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-21">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NFTSellOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTSellOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-21" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/NFTSellOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NFTSellOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTSellOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L318">packages/xrpl/src/client/index.ts:318</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-22">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/NoRippleCheckRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-22" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/NoRippleCheckRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L319">packages/xrpl/src/client/index.ts:319</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-23">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../types/PathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Type alias">PathFindRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-23" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../types/PathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Type alias">PathFindRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L320">packages/xrpl/src/client/index.ts:320</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-24">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/PingRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PingRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-24" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/PingRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PingRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L321">packages/xrpl/src/client/index.ts:321</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-25">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/RandomRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-25" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/RandomRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L322">packages/xrpl/src/client/index.ts:322</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-26">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/RipplePathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-26" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/RipplePathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L323">packages/xrpl/src/client/index.ts:323</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-27">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServerInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-27" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/ServerInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L326">packages/xrpl/src/client/index.ts:326</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-28">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServerStateRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-28" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/ServerStateRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L327">packages/xrpl/src/client/index.ts:327</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-29">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubmitRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-29" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/SubmitRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L328">packages/xrpl/src/client/index.ts:328</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-30">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubmitMultisignedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-30" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/SubmitMultisignedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L329">packages/xrpl/src/client/index.ts:329</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-31">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/SubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-31" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/SubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L332">packages/xrpl/src/client/index.ts:332</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-32">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/UnsubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-32" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/UnsubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L333">packages/xrpl/src/client/index.ts:333</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-33">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/TransactionEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-33" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/TransactionEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L334">packages/xrpl/src/client/index.ts:334</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-34">request<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><a href="../interfaces/TxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span><a href="#request.request-34" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <a href="../interfaces/TxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TxRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L337">packages/xrpl/src/client/index.ts:337</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-35">request<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><a href="#request.request-35" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
|
||
additional request body parameters.</p>
|
||
|
||
<h3>Returns</h3><p>The response from the server.</p>
|
||
</div>
|
||
<section class="tsd-panel tsd-type-parameters">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameters">
|
||
<li>
|
||
<h4>R<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">BaseRequest</span></h4></li>
|
||
<li>
|
||
<h4>T<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">BaseResponse</span></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>r: <span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L338">packages/xrpl/src/client/index.ts:338</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="requestAll" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">request<wbr/>All</span><a href="#requestAll" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-1">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"><</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><a href="#requestAll.requestAll-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>req: <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L480">packages/xrpl/src/client/index.ts:480</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-2">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||
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>
|
||
<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's built-in pagination and make multiple
|
||
requests as needed.</p>
|
||
|
||
<h3>Returns</h3><p>The array of all responses.</p>
|
||
|
||
<h3>Throws</h3><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>req: <a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L483">packages/xrpl/src/client/index.ts:483</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-3">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||
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>
|
||
<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's built-in pagination and make multiple
|
||
requests as needed.</p>
|
||
|
||
<h3>Returns</h3><p>The array of all responses.</p>
|
||
|
||
<h3>Throws</h3><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>req: <a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L486">packages/xrpl/src/client/index.ts:486</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-4">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||
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>
|
||
<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's built-in pagination and make multiple
|
||
requests as needed.</p>
|
||
|
||
<h3>Returns</h3><p>The array of all responses.</p>
|
||
|
||
<h3>Throws</h3><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>req: <a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-5">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-5" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||
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>
|
||
<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's built-in pagination and make multiple
|
||
requests as needed.</p>
|
||
|
||
<h3>Returns</h3><p>The array of all responses.</p>
|
||
|
||
<h3>Throws</h3><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>req: <a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L492">packages/xrpl/src/client/index.ts:492</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-6">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-6" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||
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>
|
||
<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's built-in pagination and make multiple
|
||
requests as needed.</p>
|
||
|
||
<h3>Returns</h3><p>The array of all responses.</p>
|
||
|
||
<h3>Throws</h3><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>req: <a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L493">packages/xrpl/src/client/index.ts:493</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-7">request<wbr/>All<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#requestAll.requestAll-7" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
|
||
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>
|
||
<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's built-in pagination and make multiple
|
||
requests as needed.</p>
|
||
|
||
<h3>Returns</h3><p>The array of all responses.</p>
|
||
|
||
<h3>Throws</h3><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>req: <a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L494">packages/xrpl/src/client/index.ts:494</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="requestNextPage" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">request<wbr/>Next<wbr/>Page</span><a href="#requestNextPage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-1">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"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>req: <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a></h5></li>
|
||
<li>
|
||
<h5>resp: <a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L370">packages/xrpl/src/client/index.ts:370</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-2">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||
|
||
<h3>Returns</h3><p>The response with the next page of data.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<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"><p>Request to send.</p>
|
||
</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"><p>Response with the marker to use in the request.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L374">packages/xrpl/src/client/index.ts:374</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-3">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||
|
||
<h3>Returns</h3><p>The response with the next page of data.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<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"><p>Request to send.</p>
|
||
</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"><p>Response with the marker to use in the request.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L378">packages/xrpl/src/client/index.ts:378</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-4">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||
|
||
<h3>Returns</h3><p>The response with the next page of data.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<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"><p>Request to send.</p>
|
||
</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"><p>Response with the marker to use in the request.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L382">packages/xrpl/src/client/index.ts:382</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-5">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-5" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||
|
||
<h3>Returns</h3><p>The response with the next page of data.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<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"><p>Request to send.</p>
|
||
</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"><p>Response with the marker to use in the request.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L386">packages/xrpl/src/client/index.ts:386</a></li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-6">request<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a>, resp<span class="tsd-signature-symbol">: </span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span><a href="#requestNextPage.requestNextPage-6" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
|
||
|
||
<h3>Returns</h3><p>The response with the next page of data.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<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"><p>Request to send.</p>
|
||
</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"><p>Response with the marker to use in the request.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<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/1a1d8087/packages/xrpl/src/client/index.ts#L390">packages/xrpl/src/client/index.ts:390</a></li></ul></aside></li></ul></section></section>
|
||
<section class="tsd-panel-group tsd-member-group tsd-kind-class">
|
||
<h2>Other</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="clients" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">clients</span><a href="#clients" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">clients<span class="tsd-signature-symbol">:</span> <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/BroadcastClient.ts#L19">packages/xrpl/src/client/BroadcastClient.ts:19</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="connection" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">connection</span><a href="#connection" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Connection</span></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#connection">connection</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L185">packages/xrpl/src/client/index.ts:185</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="prepareTransaction" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">prepare<wbr/>Transaction</span><a href="#prepareTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">prepare<wbr/>Transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, signersCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = autofill</span></div>
|
||
<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-property">
|
||
<li class="tsd-signature" id="prepareTransaction.__type-12.__type-13"><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a>, transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, signersCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography">
|
||
<h3>Deprecated</h3><p>Use autofill instead, provided for users familiar with v1</p>
|
||
</div>
|
||
<section class="tsd-panel tsd-type-parameters">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameters">
|
||
<li>
|
||
<h4>T<span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>this: <a href="Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h5></li>
|
||
<li>
|
||
<h5>transaction: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> signersCount: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#prepareTransaction">prepareTransaction</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/index.ts#L615">packages/xrpl/src/client/index.ts:615</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="BroadcastClient.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources">
|
||
<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:38</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureRejections" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span class="deprecated">capture<wbr/>Rejections</span><a href="#captureRejections" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">capture<wbr/>Rejections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Sets or gets the default captureRejection value for all emitters.</p>
|
||
</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:44</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="defaultMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span class="deprecated">default<wbr/>Max<wbr/>Listeners</span><a href="#defaultMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">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:45</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="errorMonitor" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">error<wbr/>Monitor</span><a href="#errorMonitor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<div class="tsd-signature">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>
|
||
<div class="tsd-comment tsd-typography"><p>This symbol shall be used to install a listener for only monitoring <code>'error'</code>
|
||
events. Listeners installed using this symbol are called before the regular
|
||
<code>'error'</code> listeners are called.</p>
|
||
<p>Installing a listener using this symbol does not change the behavior once an
|
||
<code>'error'</code> event is emitted, therefore the process will still crash if no
|
||
regular <code>'error'</code> listener is installed.</p>
|
||
</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:37</li></ul></aside></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 class="tsd-anchor-link"><span class="deprecated">add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-1">add<wbr/>Listener<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>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#addListener.addListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <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><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></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"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#addListener">addListener</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:57</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-1">emit<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>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><a href="#emit.emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#emit">emit</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:67</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="eventNames" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">event<wbr/>Names</span><a href="#eventNames" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="eventNames.eventNames-1">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><a href="#eventNames.eventNames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<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><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:72</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="getMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Max<wbr/>Listeners</span><a href="#getMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="getMaxListeners.getMaxListeners-1">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><a href="#getMaxListeners.getMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><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:64</li></ul></aside></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 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span class="deprecated">get<wbr/>Method<wbr/>Names</span><a href="#getMethodNames" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||
<li class="tsd-signature tsd-anchor-link" id="getMethodNames.getMethodNames-1">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><a href="#getMethodNames.getMethodNames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Gets the method names of all the methods of the client.</p>
|
||
|
||
<h3>Returns</h3><p>A list of the names of all the methods of the client.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/client/BroadcastClient.ts#L66">packages/xrpl/src/client/BroadcastClient.ts:66</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="listenerCount.listenerCount-1">listener<wbr/>Count<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><span class="tsd-signature-type">number</span><a href="#listenerCount.listenerCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><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:68</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1">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><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#listeners">listeners</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:65</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="off.off-1">off<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>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <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><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></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"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#off">off</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:61</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-1">once<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>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#once.once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <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><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></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"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#once">once</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:59</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prependListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">prepend<wbr/>Listener</span><a href="#prependListener" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-1">prepend<wbr/>Listener<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>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#prependListener.prependListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <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><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></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"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#prependListener">prependListener</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:70</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prependOnceListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">prepend<wbr/>Once<wbr/>Listener</span><a href="#prependOnceListener" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-1">prepend<wbr/>Once<wbr/>Listener<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>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#prependOnceListener.prependOnceListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <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><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></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"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#prependOnceListener">prependOnceListener</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:71</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">raw<wbr/>Listeners</span><a href="#rawListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="rawListeners.rawListeners-1">raw<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><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span><a href="#rawListeners.rawListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#rawListeners">rawListeners</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:66</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="removeAllListeners.removeAllListeners-1">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><a href="#removeAllListeners.removeAllListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#removeAllListeners">removeAllListeners</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:62</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">remove<wbr/>Listener</span><a href="#removeListener" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1">remove<wbr/>Listener<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>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a><a href="#removeListener.removeListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>event: <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><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></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"><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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#removeListener">removeListener</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:60</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="setMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span class="deprecated">set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners.setMaxListeners-1">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><a href="#setMaxListeners.setMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>n: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="BroadcastClient.html" class="tsd-signature-type" data-tsd-kind="Class">BroadcastClient</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#setMaxListeners">setMaxListeners</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:63</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listenerCount-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span class="deprecated">listener<wbr/>Count</span><a href="#listenerCount-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="listenerCount-2.listenerCount-3">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, 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><span class="tsd-signature-type">number</span><a href="#listenerCount-2.listenerCount-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography">
|
||
<h3>Deprecated</h3><p>since v4.0.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5></li>
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#listenerCount-2">listenerCount</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:26</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="on-11" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span class="deprecated">on</span><a href="#on-11" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="on-11.on-12">on<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</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-symbol">: </span><span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#on-11.on-12" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5></li>
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#on-11">on</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:23</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="once-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span class="deprecated">once</span><a href="#once-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="once-2.once-3">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeEventTarget</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><span class="tsd-signature-type">Promise</span><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><a href="#once-2.once-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>emitter: <span class="tsd-signature-type">NodeEventTarget</span></h5></li>
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#once-2">once</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:21</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once-2.once-4">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMEventTarget</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-symbol">: </span><span class="tsd-signature-type">Promise</span><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><a href="#once-2.once-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>emitter: <span class="tsd-signature-type">DOMEventTarget</span></h5></li>
|
||
<li>
|
||
<h5>event: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Client.html">Client</a>.<a href="Client.html#once-2">once</a></p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:22</li></ul></aside></li></ul></section></section></div>
|
||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
<div class="tsd-navigation settings">
|
||
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
||
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
||
<div class="tsd-accordion-details">
|
||
<div class="tsd-filter-visibility">
|
||
<h4 class="uppercase">Member Visibility</h4><form>
|
||
<ul id="tsd-filter-options">
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
||
<div class="tsd-theme-toggle">
|
||
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
||
<nav class="tsd-navigation primary">
|
||
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
||
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul>
|
||
<li><a href="../modules.html">xrpl</a>
|
||
<ul>
|
||
<li class="tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></li></ul></div></details></nav>
|
||
<nav class="tsd-navigation secondary menu-sticky">
|
||
<ul>
|
||
<li class="deprecated current tsd-kind-class"><a href="BroadcastClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Broadcast<wbr/>Client</span></a>
|
||
<ul>
|
||
<li class="deprecated tsd-kind-constructor tsd-parent-kind-class"><a href="BroadcastClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#autofill" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>autofill</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BroadcastClient.html#clients" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>clients</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#connection" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>connection</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#feeCushion" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>fee<wbr/>Cushion</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#fundWallet" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>fund<wbr/>Wallet</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getBalances" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>get<wbr/>Balances</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getLedgerIndex" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>get<wbr/>Ledger<wbr/>Index</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getOrderbook" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>get<wbr/>Orderbook</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#getXrpBalance" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>get<wbr/>Xrp<wbr/>Balance</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#maxFeeXRP" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>max<wbr/>FeeXRP</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#prepareTransaction" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Transaction</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#submit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>submit</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#submitAndWait" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>submit<wbr/>And<wbr/>Wait</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#captureRejectionSymbol" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>capture<wbr/>Rejection<wbr/>Symbol</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#captureRejections" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>capture<wbr/>Rejections</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#defaultMaxListeners" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>default<wbr/>Max<wbr/>Listeners</a></li>
|
||
<li class="deprecated tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#errorMonitor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>error<wbr/>Monitor</a></li>
|
||
<li class="deprecated tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#url" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>url</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#addListener" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Listener</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#connect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>connect</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#disconnect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>disconnect</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#emit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>emit</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#eventNames" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>event<wbr/>Names</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#getMaxListeners" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Max<wbr/>Listeners</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BroadcastClient.html#getMethodNames" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Method<wbr/>Names</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#isConnected" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Connected</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#listenerCount" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>listener<wbr/>Count</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#listeners" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>listeners</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#off" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>off</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>on</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#once" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>once</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#prependListener" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>prepend<wbr/>Listener</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#prependOnceListener" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>prepend<wbr/>Once<wbr/>Listener</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#rawListeners" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>raw<wbr/>Listeners</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#removeAllListeners" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove<wbr/>All<wbr/>Listeners</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#removeListener" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove<wbr/>Listener</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#request" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>request</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#requestAll" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>request<wbr/>All</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BroadcastClient.html#requestNextPage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>request<wbr/>Next<wbr/>Page</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#setMaxListeners" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Max<wbr/>Listeners</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#listenerCount-2" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>listener<wbr/>Count</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#on-11" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>on</a></li>
|
||
<li class="deprecated tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="BroadcastClient.html#once-2" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>once</a></li></ul></li></ul></nav></div></div>
|
||
<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> |