mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 12:15:51 +00:00
6 lines
35 KiB
HTML
6 lines
35 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OrderBookStream | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="OrderBookStream.html">OrderBookStream</a></li></ul><h1>Interface OrderBookStream</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>When you subscribe to one or more order books with the <code>books</code> field, you
|
|
get back any transactions that affect those order books. Has the same format
|
|
as a <a href="TransactionStream.html">TransactionStream</a> but the transaction can have a <code>owner_funds</code>
|
|
field.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseStream</span><ul class="tsd-hierarchy"><li><span class="target">OrderBookStream</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#engine_result" class="tsd-kind-icon">engine_<wbr/>result</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#engine_result_code" class="tsd-kind-icon">engine_<wbr/>result_<wbr/>code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#engine_result_message" class="tsd-kind-icon">engine_<wbr/>result_<wbr/>message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_current_index" class="tsd-kind-icon">ledger_<wbr/>current_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#meta" class="tsd-kind-icon">meta</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#transaction" class="tsd-kind-icon">transaction</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OrderBookStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#validated" class="tsd-kind-icon">validated</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="engine_result" class="tsd-anchor"></a><h3 class="tsd-anchor-link">engine_<wbr/>result<a href="#engine_result" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">engine_<wbr/>result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L338">packages/xrpl/src/models/methods/subscribe.ts:338</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="engine_result_code" class="tsd-anchor"></a><h3 class="tsd-anchor-link">engine_<wbr/>result_<wbr/>code<a href="#engine_result_code" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">engine_<wbr/>result_<wbr/>code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L339">packages/xrpl/src/models/methods/subscribe.ts:339</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="engine_result_message" class="tsd-anchor"></a><h3 class="tsd-anchor-link">engine_<wbr/>result_<wbr/>message<a href="#engine_result_message" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">engine_<wbr/>result_<wbr/>message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L340">packages/xrpl/src/models/methods/subscribe.ts:340</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_current_index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>current_<wbr/>index<a href="#ledger_current_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>current_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L341">packages/xrpl/src/models/methods/subscribe.ts:341</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L342">packages/xrpl/src/models/methods/subscribe.ts:342</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L343">packages/xrpl/src/models/methods/subscribe.ts:343</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="meta" class="tsd-anchor"></a><h3 class="tsd-anchor-link">meta<a href="#meta" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">meta<span class="tsd-signature-symbol">:</span> <a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L344">packages/xrpl/src/models/methods/subscribe.ts:344</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link">status<a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L336">packages/xrpl/src/models/methods/subscribe.ts:336</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transaction<a href="#transaction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><a href="AccountDelete.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDelete</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="AccountSet.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="CheckCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="CheckCash.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCash</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="CheckCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="DepositPreauth.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositPreauth</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="EscrowCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="EscrowCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="EscrowFinish.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowFinish</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="NFTokenAcceptOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenAcceptOffer</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="NFTokenBurn.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenBurn</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="NFTokenCancelOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenCancelOffer</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="NFTokenCreateOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenCreateOffer</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="NFTokenMint.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenMint</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="OfferCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="OfferCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="Payment.html" class="tsd-signature-type" data-tsd-kind="Interface">Payment</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="PaymentChannelClaim.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelClaim</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="PaymentChannelCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="PaymentChannelFund.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelFund</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="SetRegularKey.html" class="tsd-signature-type" data-tsd-kind="Interface">SetRegularKey</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="SignerListSet.html" class="tsd-signature-type" data-tsd-kind="Interface">SignerListSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="TicketCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">TicketCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><a href="TrustSet.html" class="tsd-signature-type" data-tsd-kind="Interface">TrustSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">ModifiedOfferCreateTransaction</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L345">packages/xrpl/src/models/methods/subscribe.ts:345</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link">type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"transaction"</span></div><aside class="tsd-sources"><p>Overrides BaseStream.type</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L337">packages/xrpl/src/models/methods/subscribe.ts:337</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="validated" class="tsd-anchor"></a><h3 class="tsd-anchor-link">validated<a href="#validated" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">validated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/methods/subscribe.ts#L356">packages/xrpl/src/models/methods/subscribe.ts:356</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="OrderBookStream.html" class="tsd-kind-icon">Order<wbr/>Book<wbr/>Stream</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#engine_result" class="tsd-kind-icon">engine_<wbr/>result</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#engine_result_code" class="tsd-kind-icon">engine_<wbr/>result_<wbr/>code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#engine_result_message" class="tsd-kind-icon">engine_<wbr/>result_<wbr/>message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_current_index" class="tsd-kind-icon">ledger_<wbr/>current_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#meta" class="tsd-kind-icon">meta</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#transaction" class="tsd-kind-icon">transaction</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OrderBookStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#validated" class="tsd-kind-icon">validated</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |