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

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

View File

@@ -3,7 +3,7 @@
transaction flags.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-typescript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">paymentChannelClaim</span><span class="hl-1">: </span><span class="hl-8">PaymentChannelClaim</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-5">&#39;rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj</span><span class="hl-11">,</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType</span><span class="hl-1">: </span><span class="hl-5">&#39;PaymentChannelClaim&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Channel:</span><span class="hl-1"> </span><span class="hl-0">hashes</span><span class="hl-1">.</span><span class="hl-4">hashPaymentChannel</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-5">&#39;rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">&#39;rQGYqiyH5Ue9J96p4E6Qt6AvqxK4sDhnS5&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-9">21970712</span><span class="hl-1">,</span><br/><span class="hl-1"> ),</span><br/><span class="hl-1"> </span><span class="hl-0">Amount:</span><span class="hl-1"> </span><span class="hl-5">&#39;100&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Flags:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">tfClose:</span><span class="hl-1"> </span><span class="hl-2">true</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-7">// Autofill the tx to see how flags actually look compared to the interface usage.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">autofilledTx</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">autofill</span><span class="hl-1">(</span><span class="hl-0">paymentChannelClaim</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">autofilledTx</span><span class="hl-1">)</span><br/><span class="hl-7">// {</span><br/><span class="hl-7">// Account: &#39;rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj&#39;,</span><br/><span class="hl-7">// TransactionType: &#39;PaymentChannelClaim&#39;,</span><br/><span class="hl-7">// Channel: &#39;FC14BF9245D731DC1749EE0F070765E4EB4E993F8ECEE3D00F7E6E26D6EF98CF&#39;,</span><br/><span class="hl-7">// Amount: &#39;100&#39;,</span><br/><span class="hl-7">// Flags: 131072,</span><br/><span class="hl-7">// Sequence: 21970713,</span><br/><span class="hl-7">// Fee: &#39;12&#39;,</span><br/><span class="hl-7">// LastLedgerSequence: 21970658</span><br/><span class="hl-7">// }</span>
</code></pre>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">GlobalFlags</span><ul class="tsd-hierarchy"><li><span class="target">PaymentChannelClaimFlagsInterface</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"><a href="PaymentChannelClaimFlagsInterface.html#tfClose" class="tsd-kind-icon">tf<wbr/>Close</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaimFlagsInterface.html#tfRenew" class="tsd-kind-icon">tf<wbr/>Renew</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"><a name="tfClose" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Close</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Close<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/transactions/paymentChannelClaim.ts#L91">src/models/transactions/paymentChannelClaim.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">GlobalFlags</span><ul class="tsd-hierarchy"><li><span class="target">PaymentChannelClaimFlagsInterface</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"><a href="PaymentChannelClaimFlagsInterface.html#tfClose" class="tsd-kind-icon">tf<wbr/>Close</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaimFlagsInterface.html#tfRenew" class="tsd-kind-icon">tf<wbr/>Renew</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"><a name="tfClose" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Close</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Close<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/transactions/paymentChannelClaim.ts#L91">src/models/transactions/paymentChannelClaim.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Request to close the channel. Only the channel source and destination
addresses can use this flag. This flag closes the channel immediately if it
has no more XRP allocated to it after processing the current claim, or if
@@ -15,7 +15,7 @@ SettleDelay time, unless the channel already has an earlier Expiration
time.) If the destination address uses this flag when the channel still
holds XRP, any XRP that remains after processing the claim is returned to
the source address.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfRenew" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Renew</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Renew<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/transactions/paymentChannelClaim.ts#L77">src/models/transactions/paymentChannelClaim.ts:77</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="tfRenew" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Renew</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Renew<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/transactions/paymentChannelClaim.ts#L77">src/models/transactions/paymentChannelClaim.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Clear the channel&#39;s Expiration time. (Expiration is different from the
channel&#39;s immutable CancelAfter time.) Only the source address of the
payment channel can use this flag.</p>