mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-27 23:55:49 +00:00
build: update package.json version for release (#1755)
* build: update xrpl.js for release
This commit is contained in:
Nathan Nichols
@@ -1,328 +1,24 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>PathFindStream | xrpl</title>
|
||||
<meta name="description" content="Documentation for xrpl">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<script async src="../assets/js/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-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</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="PathFindStream.html">PathFindStream</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface PathFindStream</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>The path_find method searches for a path along which a transaction can
|
||||
possibly be made, and periodically sends updates when the path changes over
|
||||
time.</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">PathFindStream</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="PathFindStream.html#alternatives" class="tsd-kind-icon">alternatives</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_amount" class="tsd-kind-icon">destination_<wbr>amount</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#full_reply" class="tsd-kind-icon">full_<wbr>reply</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#id" class="tsd-kind-icon">id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#send_max" class="tsd-kind-icon">send_<wbr>max</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#source_account" class="tsd-kind-icon">source_<wbr>account</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PathFindStream.html#type" class="tsd-kind-icon">type</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="alternatives" class="tsd-anchor"></a>
|
||||
<h3>alternatives</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">alternatives<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>paths_computed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Path</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>source_amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</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/615504db/src/models/methods/subscribe.ts#L347">src/models/methods/subscribe.ts:347</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Array of objects with suggested paths to take. If empty, then no paths
|
||||
were found connecting the source and destination accounts.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>paths_<wbr>computed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Path</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>source_<wbr>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="destination_account" class="tsd-anchor"></a>
|
||||
<h3>destination_<wbr>account</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">destination_<wbr>account<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/615504db/src/models/methods/subscribe.ts#L328">src/models/methods/subscribe.ts:328</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Unique address of the account that would receive a transaction.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="destination_amount" class="tsd-anchor"></a>
|
||||
<h3>destination_<wbr>amount</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">destination_<wbr>amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L330">src/models/methods/subscribe.ts:330</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Currency Amount that the destination would receive in a transaction.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="full_reply" class="tsd-anchor"></a>
|
||||
<h3>full_<wbr>reply</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">full_<wbr>reply<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/615504db/src/models/methods/subscribe.ts#L338">src/models/methods/subscribe.ts:338</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>If false, this is the result of an incomplete search. A later reply may
|
||||
have a better path. If true, then this is the best path found. (It is still
|
||||
theoretically possible that a better path could exist, but rippled won't
|
||||
find it.) Until you close the pathfinding request, rippled continues to
|
||||
send updates each time a new ledger closes.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="id" class="tsd-anchor"></a>
|
||||
<h3>id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/615504db/src/models/methods/subscribe.ts#L340">src/models/methods/subscribe.ts:340</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The ID provided in the WebSocket request is included again at this level.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="send_max" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> send_<wbr>max</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">send_<wbr>max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L342">src/models/methods/subscribe.ts:342</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Currency Amount that would be spent in the transaction.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="source_account" class="tsd-anchor"></a>
|
||||
<h3>source_<wbr>account</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">source_<wbr>account<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/615504db/src/models/methods/subscribe.ts#L326">src/models/methods/subscribe.ts:326</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Unique address that would send a transaction.</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">"path_find"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides BaseStream.type</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L324">src/models/methods/subscribe.ts:324</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>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
<a href="PathFindStream.html" class="tsd-kind-icon">Path<wbr>Find<wbr>Stream</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="PathFindStream.html#alternatives" class="tsd-kind-icon">alternatives</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="PathFindStream.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="PathFindStream.html#destination_amount" class="tsd-kind-icon">destination_<wbr>amount</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="PathFindStream.html#full_reply" class="tsd-kind-icon">full_<wbr>reply</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="PathFindStream.html#id" class="tsd-kind-icon">id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="PathFindStream.html#send_max" class="tsd-kind-icon">send_<wbr>max</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="PathFindStream.html#source_account" class="tsd-kind-icon">source_<wbr>account</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
||||
<a href="PathFindStream.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</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>
|
||||
</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/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PathFindStream | 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="PathFindStream.html">PathFindStream</a></li></ul><h1>Interface PathFindStream</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>The path_find method searches for a path along which a transaction can
|
||||
possibly be made, and periodically sends updates when the path changes over
|
||||
time.</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">PathFindStream</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="PathFindStream.html#alternatives" class="tsd-kind-icon">alternatives</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_account" class="tsd-kind-icon">destination_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_amount" class="tsd-kind-icon">destination_<wbr/>amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#full_reply" class="tsd-kind-icon">full_<wbr/>reply</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#send_max" class="tsd-kind-icon">send_<wbr/>max</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#source_account" class="tsd-kind-icon">source_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PathFindStream.html#type" class="tsd-kind-icon">type</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="alternatives" class="tsd-anchor"></a><h3>alternatives</h3><div class="tsd-signature tsd-kind-icon">alternatives<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>paths_computed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Path</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>source_amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</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/922be621/src/models/methods/subscribe.ts#L390">src/models/methods/subscribe.ts:390</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Array of objects with suggested paths to take. If empty, then no paths
|
||||
were found connecting the source and destination accounts.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="destination_account" class="tsd-anchor"></a><h3>destination_<wbr/>account</h3><div class="tsd-signature tsd-kind-icon">destination_<wbr/>account<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/922be621/src/models/methods/subscribe.ts#L371">src/models/methods/subscribe.ts:371</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Unique address of the account that would receive a transaction.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="destination_amount" class="tsd-anchor"></a><h3>destination_<wbr/>amount</h3><div class="tsd-signature tsd-kind-icon">destination_<wbr/>amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/methods/subscribe.ts#L373">src/models/methods/subscribe.ts:373</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Currency Amount that the destination would receive in a transaction.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="full_reply" class="tsd-anchor"></a><h3>full_<wbr/>reply</h3><div class="tsd-signature tsd-kind-icon">full_<wbr/>reply<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/922be621/src/models/methods/subscribe.ts#L381">src/models/methods/subscribe.ts:381</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If false, this is the result of an incomplete search. A later reply may
|
||||
have a better path. If true, then this is the best path found. (It is still
|
||||
theoretically possible that a better path could exist, but rippled won't
|
||||
find it.) Until you close the pathfinding request, rippled continues to
|
||||
send updates each time a new ledger closes.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/922be621/src/models/methods/subscribe.ts#L383">src/models/methods/subscribe.ts:383</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The ID provided in the WebSocket request is included again at this level.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="send_max" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> send_<wbr/>max</h3><div class="tsd-signature tsd-kind-icon">send_<wbr/>max<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Amount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/methods/subscribe.ts#L385">src/models/methods/subscribe.ts:385</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Currency Amount that would be spent in the transaction.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="source_account" class="tsd-anchor"></a><h3>source_<wbr/>account</h3><div class="tsd-signature tsd-kind-icon">source_<wbr/>account<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/922be621/src/models/methods/subscribe.ts#L369">src/models/methods/subscribe.ts:369</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Unique address that would send a transaction.</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">"path_find"</span></div><aside class="tsd-sources"><p>Overrides BaseStream.type</p><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/methods/subscribe.ts#L367">src/models/methods/subscribe.ts:367</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="PathFindStream.html" class="tsd-kind-icon">Path<wbr/>Find<wbr/>Stream</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#alternatives" class="tsd-kind-icon">alternatives</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_account" class="tsd-kind-icon">destination_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_amount" class="tsd-kind-icon">destination_<wbr/>amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#full_reply" class="tsd-kind-icon">full_<wbr/>reply</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#send_max" class="tsd-kind-icon">send_<wbr/>max</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#source_account" class="tsd-kind-icon">source_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PathFindStream.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
Reference in New Issue
Block a user