mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-21 04:35:49 +00:00
e813ec4bd3
Make all exported function parameters and return types show their shapes so that new developers can see how to use them in the docs.
25 lines
17 KiB
HTML
25 lines
17 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TransactionStream | 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><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="TransactionStream.html">TransactionStream</a></li></ul><h1>Interface TransactionStream</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>Many subscriptions result in messages about transactions.</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">TransactionStream</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="TransactionStream.html#engine_result" class="tsd-kind-icon">engine_<wbr/>result</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.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="TransactionStream.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="TransactionStream.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="TransactionStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#meta" class="tsd-kind-icon">meta</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#transaction" class="tsd-kind-icon">transaction</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="TransactionStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#validated" class="tsd-kind-icon">validated</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#warnings" class="tsd-kind-icon">warnings</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 name="engine_result" class="tsd-anchor"></a><h3>engine_<wbr/>result</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L251">src/models/methods/subscribe.ts:251</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>String Transaction result code.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="engine_result_code" class="tsd-anchor"></a><h3>engine_<wbr/>result_<wbr/>code</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L253">src/models/methods/subscribe.ts:253</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Numeric transaction response code, if applicable.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="engine_result_message" class="tsd-anchor"></a><h3>engine_<wbr/>result_<wbr/>message</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L255">src/models/methods/subscribe.ts:255</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Human-readable explanation for the transaction response.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ledger_current_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>current_<wbr/>index</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L260">src/models/methods/subscribe.ts:260</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ledger index of the current in-progress ledger version for which this
|
|
transaction is currently proposed.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L262">src/models/methods/subscribe.ts:262</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The identifying hash of the ledger version that includes this transaction.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L264">src/models/methods/subscribe.ts:264</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ledger index of the ledger version that includes this transaction.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="meta" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> meta</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L269">src/models/methods/subscribe.ts:269</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The transaction metadata, which shows the exact outcome of the transaction
|
|
in detail.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="status" class="tsd-anchor"></a><h3>status</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L248">src/models/methods/subscribe.ts:248</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="transaction" class="tsd-anchor"></a><h3>transaction</h3><div class="tsd-signature tsd-kind-icon">transaction<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L271">src/models/methods/subscribe.ts:271</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The definition of the transaction in JSON format.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a name="type" class="tsd-anchor"></a><h3>type</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L249">src/models/methods/subscribe.ts:249</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="validated" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> validated</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L277">src/models/methods/subscribe.ts:277</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true, this transaction is included in a validated ledger and its
|
|
outcome is final. Responses from the transaction stream should always be
|
|
validated.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="warnings" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3><div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>message<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/ripple/ripple-lib/blob/34f172cc/src/models/methods/subscribe.ts#L278">src/models/methods/subscribe.ts:278</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="TransactionStream.html" class="tsd-kind-icon">Transaction<wbr/>Stream</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#engine_result" class="tsd-kind-icon">engine_<wbr/>result</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.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="TransactionStream.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="TransactionStream.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="TransactionStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#meta" class="tsd-kind-icon">meta</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#transaction" class="tsd-kind-icon">transaction</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="TransactionStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#validated" class="tsd-kind-icon">validated</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TransactionStream.html#warnings" class="tsd-kind-icon">warnings</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> |