ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

build: generates documentation (#1716)

Browse Source
This commit is contained in:
Nathan Nichols
2021-10-12 15:06:44 -05:00
committed by GitHub
parent 615504db22
commit 75e56ca927
128 changed files with 26290 additions and 11898 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
docs/interfaces/LedgerRequest.html
View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<title>LedgerRequest | 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>
@@ -23,7 +23,7 @@
<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">ripple-lib</a>
<a href="../index.html" class="title">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="LedgerRequest.html">LedgerRequest</a>
@@ -65,6 +65,29 @@
<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>Retrieve information about the public ledger. Expects a response in the form
of a <a href="LedgerResponse.html">LedgerResponse</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ledger</span><span style="color: #000000">: </span><span style="color: #267F99">LedgerRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;id&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #098658">14</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;command&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_index&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;validated&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;full&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;accounts&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;transactions&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;expand&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;owner_funds&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span>
<span style="color: #000000">}</span>
</code></pre>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
@@ -110,9 +133,15 @@
<div class="tsd-signature tsd-kind-icon">accounts<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/0c571f2e/src/models/methods/ledger.ts#L13">src/models/methods/ledger.ts:13</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L46">src/models/methods/ledger.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Admin required. If true, return information on accounts in the ledger.
Ignored if you did not specify a ledger version. Defaults to false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
@@ -121,9 +150,14 @@
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/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">
<a name="binary" class="tsd-anchor"></a>
@@ -131,9 +165,16 @@
<div class="tsd-signature tsd-kind-icon">binary<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/0c571f2e/src/models/methods/ledger.ts#L17">src/models/methods/ledger.ts:17</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L70">src/models/methods/ledger.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, and transactions and expand are both also true, return
transaction information in binary format (hexadecimal string) instead of
JSON format.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
@@ -142,7 +183,7 @@
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L9">src/models/methods/ledger.ts:9</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L29">src/models/methods/ledger.ts:29</a></li>
</ul>
</aside>
</section>
@@ -152,9 +193,16 @@
<div class="tsd-signature tsd-kind-icon">expand<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/0c571f2e/src/models/methods/ledger.ts#L15">src/models/methods/ledger.ts:15</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L58">src/models/methods/ledger.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Provide full JSON-formatted information for transaction/account
information instead of only hashes. Defaults to false. Ignored unless you
request transactions, accounts, or both.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="full" class="tsd-anchor"></a>
@@ -162,9 +210,15 @@
<div class="tsd-signature tsd-kind-icon">full<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/0c571f2e/src/models/methods/ledger.ts#L12">src/models/methods/ledger.ts:12</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L41">src/models/methods/ledger.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Admin required If true, return full information on the entire ledger.
Ignored if you did not specify a ledger version. Defaults to false.</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>
@@ -173,9 +227,16 @@
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/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="ledger_hash" class="tsd-anchor"></a>
@@ -183,9 +244,14 @@
<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/0c571f2e/src/models/methods/ledger.ts#L10">src/models/methods/ledger.ts:10</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L31">src/models/methods/ledger.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A 20-byte hex string for the ledger version to use.</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>
@@ -193,9 +259,15 @@
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L11">src/models/methods/ledger.ts:11</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L36">src/models/methods/ledger.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger to use, or a shortcut string to choose a
ledger automatically.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="owner_funds" class="tsd-anchor"></a>
@@ -203,9 +275,16 @@
<div class="tsd-signature tsd-kind-icon">owner_<wbr>funds<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/0c571f2e/src/models/methods/ledger.ts#L16">src/models/methods/ledger.ts:16</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L64">src/models/methods/ledger.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, include owner_funds field in the metadata of OfferCreate
transactions in the response. Defaults to false. Ignored unless
transactions are included and expand is true.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="queue" class="tsd-anchor"></a>
@@ -213,9 +292,15 @@
<div class="tsd-signature tsd-kind-icon">queue<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/0c571f2e/src/models/methods/ledger.ts#L18">src/models/methods/ledger.ts:18</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L75">src/models/methods/ledger.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, and the command is requesting the current ledger, includes an
array of queued transactions in the results.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transactions" class="tsd-anchor"></a>
@@ -223,9 +308,16 @@
<div class="tsd-signature tsd-kind-icon">transactions<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/0c571f2e/src/models/methods/ledger.ts#L14">src/models/methods/ledger.ts:14</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L52">src/models/methods/ledger.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, return information on transactions in the specified ledger
version. Defaults to false. Ignored if you did not specify a ledger
version.</p>
</div>
</div>
</section>
</section>
</div>
@@ -299,6 +391,7 @@
<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>