ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-20 12:15:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix GitHub pages (#1802)

Browse Source 
* Publish

 - ripple-address-codec@4.2.0
 - ripple-binary-codec@1.2.0
 - ripple-keypairs@1.1.0
 - xrpl@2.0.2

* moves back git hub pages docs to the top
This commit is contained in:
ledhed2222
2021-11-15 23:06:47 -05:00
committed by GitHub
parent 7cb38591ac
commit 5da0db89f4
159 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/interfaces/PathFindCreateRequest.html Normal file
View File

@@ -0,0 +1,23 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PathFindCreateRequest | 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="PathFindCreateRequest.html">PathFindCreateRequest</a></li></ul><h1>Interface PathFindCreateRequest</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>Start sending pathfinding information.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BasePathFindRequest</span><ul class="tsd-hierarchy"><li><span class="target">PathFindCreateRequest</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 tsd-is-inherited"><a href="PathFindCreateRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindCreateRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.html#destination_amount" class="tsd-kind-icon">destination_<wbr/>amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindCreateRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.html#paths" class="tsd-kind-icon">paths</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.html#send_max" class="tsd-kind-icon">send_<wbr/>max</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.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="PathFindCreateRequest.html#subcommand" class="tsd-kind-icon">subcommand</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 tsd-is-inherited"><a name="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BasePathFindRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/methods/baseMethod.ts#L14">src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The API version to use. If omitted, use version 1.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;path_find&quot;</span></div><aside class="tsd-sources"><p>Inherited from BasePathFindRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/methods/pathFind.ts#L6">src/models/methods/pathFind.ts:6</a></li></ul></aside></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/ripple/ripple-lib/blob/34f172cc/src/models/methods/pathFind.ts#L19">src/models/methods/pathFind.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Unique address of the account to find a path to.</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/pathFind.ts#L24">src/models/methods/pathFind.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Currency Amount that the destination account would receive in a
transaction.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> 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"><p>Inherited from BasePathFindRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/methods/baseMethod.ts#L10">src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A unique value to identify this request. The response to this request uses
the same id field. This way, even if responses arrive out of order, you
know which request prompted which response.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="paths" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3><div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Path</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/pathFind.ts#L32">src/models/methods/pathFind.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Array of arrays of objects, representing payment paths to check. You can
use this to keep updated on changes to particular paths you already know
about, or to check the overall cost to make a payment along a certain path.</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/pathFind.ts#L26">src/models/methods/pathFind.ts:26</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/ripple/ripple-lib/blob/34f172cc/src/models/methods/pathFind.ts#L17">src/models/methods/pathFind.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Unique address of the account to find a path from. In other words, the.
Account that would be sending a payment.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a name="subcommand" class="tsd-anchor"></a><h3>subcommand</h3><div class="tsd-signature tsd-kind-icon">subcommand<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;create&quot;</span></div><aside class="tsd-sources"><p>Overrides BasePathFindRequest.subcommand</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/methods/pathFind.ts#L12">src/models/methods/pathFind.ts:12</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="PathFindCreateRequest.html" class="tsd-kind-icon">Path<wbr/>Find<wbr/>Create<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindCreateRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindCreateRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.html#destination_amount" class="tsd-kind-icon">destination_<wbr/>amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindCreateRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.html#paths" class="tsd-kind-icon">paths</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.html#send_max" class="tsd-kind-icon">send_<wbr/>max</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindCreateRequest.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="PathFindCreateRequest.html#subcommand" class="tsd-kind-icon">subcommand</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>