ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-27 23:55:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

correctly document stuff (#1878)

Browse Source
This commit is contained in:
ledhed2222
2021-12-17 19:03:54 -05:00
committed by GitHub
parent 46a8adcac9
commit 7d6d119e4c
162 changed files with 1572 additions and 1125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/interfaces/SubmitRequest.html
View File

@@ -2,15 +2,15 @@
<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"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">SubmitRequest</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="SubmitRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="SubmitRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitRequest.html#fail_hard" class="tsd-kind-icon">fail_<wbr/>hard</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitRequest.html#tx_blob" class="tsd-kind-icon">tx_<wbr/>blob</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 id="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 BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">SubmitRequest</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="SubmitRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="SubmitRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitRequest.html#fail_hard" class="tsd-kind-icon">fail_<wbr/>hard</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitRequest.html#tx_blob" class="tsd-kind-icon">tx_<wbr/>blob</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 id="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 BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/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 id="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;submit&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/submit.ts#L13">ripple-lib/packages/xrpl/src/models/methods/submit.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fail_hard" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> fail_<wbr/>hard</h3><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/fcf448da/packages/xrpl/src/models/methods/submit.ts#L20">ripple-lib/packages/xrpl/src/models/methods/submit.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="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;submit&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/submit.ts#L13">packages/xrpl/src/models/methods/submit.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fail_hard" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> fail_<wbr/>hard</h3><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/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/submit.ts#L20">packages/xrpl/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 id="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 BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="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 BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/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 id="tx_blob" class="tsd-anchor"></a><h3>tx_<wbr/>blob</h3><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/fcf448da/packages/xrpl/src/models/methods/submit.ts#L15">ripple-lib/packages/xrpl/src/models/methods/submit.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tx_blob" class="tsd-anchor"></a><h3>tx_<wbr/>blob</h3><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/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/submit.ts#L15">packages/xrpl/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><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="SubmitRequest.html" class="tsd-kind-icon">Submit<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="SubmitRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitRequest.html#fail_hard" class="tsd-kind-icon">fail_<wbr/>hard</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitRequest.html#tx_blob" class="tsd-kind-icon">tx_<wbr/>blob</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>