ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-28 08:05:51 +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

51
docs/interfaces/SubmitRequest.html
View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SubmitRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<title>SubmitRequest | 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="SubmitRequest.html">SubmitRequest</a>
@@ -65,6 +65,15 @@
<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 submit method applies a transaction and sends it to the network to be
confirmed and included in future ledgers. Expects a response in the form of a
<a href="SubmitResponse.html">SubmitResponse</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
@@ -104,9 +113,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 tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
@@ -115,7 +129,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/submit.ts#L6">src/models/methods/submit.ts:6</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/submit.ts#L13">src/models/methods/submit.ts:13</a></li>
</ul>
</aside>
</section>
@@ -125,9 +139,15 @@
<div class="tsd-signature tsd-kind-icon">fail_<wbr>hard<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/submit.ts#L8">src/models/methods/submit.ts:8</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/submit.ts#L20">src/models/methods/submit.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, and the transaction fails locally, do not retry or relay the
transaction to other servers. The default is 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>
@@ -136,9 +156,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="tx_blob" class="tsd-anchor"></a>
@@ -146,9 +173,14 @@
<div class="tsd-signature tsd-kind-icon">tx_<wbr>blob<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/submit.ts#L7">src/models/methods/submit.ts:7</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/submit.ts#L15">src/models/methods/submit.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The complete transaction in hex string format.</p>
</div>
</div>
</section>
</section>
</div>
@@ -201,6 +233,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>