Skip to content

Commit

Permalink
update typedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
woodser committed Jul 4, 2024
1 parent 60fed86 commit 2c0f19b
Show file tree
Hide file tree
Showing 12 changed files with 175 additions and 88 deletions.
2 changes: 1 addition & 1 deletion docs/typedocs/assets/search.js

Large diffs are not rendered by default.

85 changes: 60 additions & 25 deletions docs/typedocs/classes/MoneroRpcConnection.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/typedocs/classes/MoneroTx.html
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Unlock<wbr/>Time</span><a href="#getU
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the minimum height or timestamp for the transactions to unlock.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><p>the minimum height or timestamp for the transactin to unlock</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><p>the minimum height or timestamp for the transaction to unlock</p>

<div class="tsd-comment tsd-typography"></div></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getVersion" class="tsd-anchor"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/typedocs/classes/MoneroTxQuery.html
Original file line number Diff line number Diff line change
Expand Up @@ -1119,7 +1119,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Unlock<wbr/>Time</span><a href="#getU
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the minimum height or timestamp for the transactions to unlock.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><p>the minimum height or timestamp for the transactin to unlock</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><p>the minimum height or timestamp for the transaction to unlock</p>

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="MoneroTxWallet.html">MoneroTxWallet</a>.<a href="MoneroTxWallet.html#getUnlockTime">getUnlockTime</a></p></aside></li></ul></section>
Expand Down
2 changes: 1 addition & 1 deletion docs/typedocs/classes/MoneroTxWallet.html
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Unlock<wbr/>Time</span><a href="#getU
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the minimum height or timestamp for the transactions to unlock.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><p>the minimum height or timestamp for the transactin to unlock</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><p>the minimum height or timestamp for the transaction to unlock</p>

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="MoneroTx.html">MoneroTx</a>.<a href="MoneroTx.html#getUnlockTime">getUnlockTime</a></p></aside></li></ul></section>
Expand Down
20 changes: 20 additions & 0 deletions docs/typedocs/classes/MoneroUtils.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ <h3 class="tsd-index-heading">Methods</h3>
<a href="MoneroUtils.html#getLastTxPubKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Last<wbr/>Tx<wbr/>Pub<wbr/>Key</span></a>
<a href="MoneroUtils.html#getVersion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Version</span></a>
<a href="MoneroUtils.html#isHex64" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Hex64</span></a>
<a href="MoneroUtils.html#isTimestamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Timestamp</span></a>
<a href="MoneroUtils.html#isValidAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Valid<wbr/>Address</span></a>
<a href="MoneroUtils.html#isValidPaymentId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Valid<wbr/>Payment<wbr/>Id</span></a>
<a href="MoneroUtils.html#isValidPrivateSpendKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Valid<wbr/>Private<wbr/>Spend<wbr/>Key</span></a>
Expand Down Expand Up @@ -210,6 +211,24 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<li>
<h5><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section>
<section class="tsd-panel tsd-member"><a id="isTimestamp" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Timestamp</span><a href="#isTimestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="isTimestamp.isTimestamp-1"><span class="tsd-kind-call-signature">is<wbr/>Timestamp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">unlockTime</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isTimestamp.isTimestamp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Determine if the given unlock time is a timestamp or block height.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">unlockTime</span>: <span class="tsd-signature-type">bigint</span></h5>
<div class="tsd-comment tsd-typography"><p>is the unlock time to check</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the unlock time is a timestamp, false if a block height</p>

<div class="tsd-comment tsd-typography"></div></li></ul></section>
<section class="tsd-panel tsd-member"><a id="isValidAddress" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Valid<wbr/>Address</span><a href="#isValidAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand Down Expand Up @@ -578,6 +597,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#getLastTxPubKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Last<wbr/>Tx<wbr/>Pub<wbr/>Key</span></a></li>
<li><a href="#getVersion" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Version</span></a></li>
<li><a href="#isHex64" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Hex64</span></a></li>
<li><a href="#isTimestamp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Timestamp</span></a></li>
<li><a href="#isValidAddress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Valid<wbr/>Address</span></a></li>
<li><a href="#isValidPaymentId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Valid<wbr/>Payment<wbr/>Id</span></a></li>
<li><a href="#isValidPrivateSpendKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Valid<wbr/>Private<wbr/>Spend<wbr/>Key</span></a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/typedocs/classes/MoneroWallet.html
Original file line number Diff line number Diff line change
Expand Up @@ -966,7 +966,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Num<wbr/>Blocks<wbr/>To<wbr/>Unlock</
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getNumBlocksToUnlock.getNumBlocksToUnlock-1"><span class="tsd-kind-call-signature">get<wbr/>Num<wbr/>Blocks<wbr/>To<wbr/>Unlock</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#getNumBlocksToUnlock.getNumBlocksToUnlock-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the number of blocks until the next and last funds unlock.</p>
<div class="tsd-comment tsd-typography"><p>Get the number of blocks until the next and last funds unlock. Ignores txs with unlock time as timestamp.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the number of blocks until the next and last funds unlock in elements 0 and 1, respectively, or undefined if no balance</p>

Expand Down
2 changes: 1 addition & 1 deletion docs/typedocs/classes/MoneroWalletFull.html
Original file line number Diff line number Diff line change
Expand Up @@ -1149,7 +1149,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Num<wbr/>Blocks<wbr/>To<wbr/>Unlock</
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getNumBlocksToUnlock.getNumBlocksToUnlock-1"><span class="tsd-kind-call-signature">get<wbr/>Num<wbr/>Blocks<wbr/>To<wbr/>Unlock</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#getNumBlocksToUnlock.getNumBlocksToUnlock-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the number of blocks until the next and last funds unlock.</p>
<div class="tsd-comment tsd-typography"><p>Get the number of blocks until the next and last funds unlock. Ignores txs with unlock time as timestamp.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the number of blocks until the next and last funds unlock in elements 0 and 1, respectively, or undefined if no balance</p>

Expand Down
2 changes: 1 addition & 1 deletion docs/typedocs/classes/MoneroWalletKeys.html
Original file line number Diff line number Diff line change
Expand Up @@ -1038,7 +1038,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Num<wbr/>Blocks<wbr/>To<wbr/>Unlock</
<ul class="tsd-signatures tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getNumBlocksToUnlock.getNumBlocksToUnlock-1"><span class="tsd-kind-call-signature">get<wbr/>Num<wbr/>Blocks<wbr/>To<wbr/>Unlock</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#getNumBlocksToUnlock.getNumBlocksToUnlock-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the number of blocks until the next and last funds unlock.</p>
<div class="tsd-comment tsd-typography"><p>Get the number of blocks until the next and last funds unlock. Ignores txs with unlock time as timestamp.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the number of blocks until the next and last funds unlock in elements 0 and 1, respectively, or undefined if no balance</p>

Expand Down
6 changes: 3 additions & 3 deletions docs/typedocs/classes/MoneroWalletRpc.html
Original file line number Diff line number Diff line change
Expand Up @@ -1021,7 +1021,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Balances</span><a href="#getBalances"
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getBalances.getBalances-1"><span class="tsd-kind-call-signature">get<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">accountIdx</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">subaddressIdx</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#getBalances.getBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the locked and unlocked balances in a single request.</p>
<div class="tsd-comment tsd-typography"><p>Get the total and unlocked balances in a single request.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1036,7 +1036,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<div class="tsd-comment tsd-typography"><p>subaddress index</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>is the locked and unlocked balances in an array, respectively</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>is the total and unlocked balances in an array, respectively</p>

<div class="tsd-comment tsd-typography"></div></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getConnectionManager" class="tsd-anchor"></a>
Expand Down Expand Up @@ -1195,7 +1195,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Num<wbr/>Blocks<wbr/>To<wbr/>Unlock</
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getNumBlocksToUnlock.getNumBlocksToUnlock-1"><span class="tsd-kind-call-signature">get<wbr/>Num<wbr/>Blocks<wbr/>To<wbr/>Unlock</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#getNumBlocksToUnlock.getNumBlocksToUnlock-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the number of blocks until the next and last funds unlock.</p>
<div class="tsd-comment tsd-typography"><p>Get the number of blocks until the next and last funds unlock. Ignores txs with unlock time as timestamp.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the number of blocks until the next and last funds unlock in elements 0 and 1, respectively, or undefined if no balance</p>

Expand Down
Loading

0 comments on commit 2c0f19b

Please sign in to comment.