ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2026-08-23 00:20:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

bug: Fix private interfaces not showing up in the docs (#1769)

Browse Source 
Make all exported function parameters and return types show their shapes so that new developers can see how to use them in the docs.
This commit is contained in:
Jackson Mills
2021-10-29 13:13:40 -07:00
committed by GitHub
parent 14395ab58f
commit e813ec4bd3
160 changed files with 1487 additions and 1171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/interfaces/SubmitMultisignedRequest.html
View File

@@ -2,16 +2,16 @@
<p>The <code>submit_multisigned</code> command applies a multi-signed transaction and sends
it to the network to be included in future ledgers. Expects a response in the
form of a <a href="SubmitMultisignedRequest.html">SubmitMultisignedRequest</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">SubmitMultisignedRequest</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="SubmitMultisignedRequest.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="SubmitMultisignedRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitMultisignedRequest.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="SubmitMultisignedRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitMultisignedRequest.html#tx_json" class="tsd-kind-icon">tx_<wbr/>json</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 BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/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">
</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">SubmitMultisignedRequest</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="SubmitMultisignedRequest.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="SubmitMultisignedRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitMultisignedRequest.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="SubmitMultisignedRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SubmitMultisignedRequest.html#tx_json" class="tsd-kind-icon">tx_<wbr/>json</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 BaseRequest.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-overwrite"><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;submit_multisigned&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/922be621/src/models/methods/submitMultisigned.ts#L13">src/models/methods/submitMultisigned.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="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/922be621/src/models/methods/submitMultisigned.ts#L24">src/models/methods/submitMultisigned.ts:24</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 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;submit_multisigned&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/34f172cc/src/models/methods/submitMultisigned.ts#L13">src/models/methods/submitMultisigned.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="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/34f172cc/src/models/methods/submitMultisigned.ts#L24">src/models/methods/submitMultisigned.ts:24</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.</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 BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/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">
</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 BaseRequest.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="tx_json" class="tsd-anchor"></a><h3>tx_<wbr/>json</h3><div class="tsd-signature tsd-kind-icon">tx_<wbr/>json<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/methods/submitMultisigned.ts#L19">src/models/methods/submitMultisigned.ts:19</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 name="tx_json" class="tsd-anchor"></a><h3>tx_<wbr/>json</h3><div class="tsd-signature tsd-kind-icon">tx_<wbr/>json<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/methods/submitMultisigned.ts#L19">src/models/methods/submitMultisigned.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Transaction in JSON format with an array of Signers. To be successful, the
weights of the signatures must be equal or higher than the quorum of the.
<a href="LedgerEntry.SignerList.html">SignerList</a>.</p>