Skip to content

Commit

Permalink
update typedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@woodser
woodser committed Sep 14, 2024
1 parent f0ccf05 commit 0818364
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs/typedocs/assets/search.js
View file

Large diffs are not rendered by default.

64 changes: 46 additions & 18 deletions docs/typedocs/classes/LibraryUtils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ <h3 class="tsd-index-heading">Properties</h3>
<a href="LibraryUtils.html#WORKER" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER</span></a>
<a href="LibraryUtils.html#WORKER_DIST_PATH" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER_<wbr/>DIST_<wbr/>PATH</span></a>
<a href="LibraryUtils.html#WORKER_DIST_PATH_DEFAULT" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER_<wbr/>DIST_<wbr/>PATH_<wbr/>DEFAULT</span></a>
<a href="LibraryUtils.html#WORKER_LOADER" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER_<wbr/>LOADER?</span></a>
<a href="LibraryUtils.html#WORKER_OBJECTS" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER_<wbr/>OBJECTS</span></a>
</div></section>
<section class="tsd-index-section">
Expand All @@ -56,8 +57,7 @@ <h3 class="tsd-index-heading">Methods</h3>
<a href="LibraryUtils.html#initWasmModule" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>init<wbr/>Wasm<wbr/>Module</span></a>
<a href="LibraryUtils.html#invokeWorker" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>invoke<wbr/>Worker</span></a>
<a href="LibraryUtils.html#isRejectUnauthorized" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Reject<wbr/>Unauthorized</span></a>
<a href="LibraryUtils.html#loadFullModule" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>Full<wbr/>Module</span></a>
<a href="LibraryUtils.html#loadKeysModule" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>Keys<wbr/>Module</span></a>
<a href="LibraryUtils.html#loadWasmModule" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>Wasm<wbr/>Module</span></a>
<a href="LibraryUtils.html#log" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>log</span></a>
<a href="LibraryUtils.html#prefixWindowsPath" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prefix<wbr/>Windows<wbr/>Path</span></a>
<a href="LibraryUtils.html#queueTask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>queue<wbr/>Task</span></a>
Expand All @@ -67,6 +67,7 @@ <h3 class="tsd-index-heading">Methods</h3>
<a href="LibraryUtils.html#setLogLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Log<wbr/>Level</span></a>
<a href="LibraryUtils.html#setRejectUnauthorizedFn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Reject<wbr/>Unauthorized<wbr/>Fn</span></a>
<a href="LibraryUtils.html#setWorkerDistPath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Dist<wbr/>Path</span></a>
<a href="LibraryUtils.html#setWorkerLoader" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Loader</span></a>
<a href="LibraryUtils.html#terminateWorker" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>terminate<wbr/>Worker</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
Expand Down Expand Up @@ -103,6 +104,17 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
<section class="tsd-panel tsd-member"><a id="WORKER_DIST_PATH_DEFAULT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>WORKER_<wbr/>DIST_<wbr/>PATH_<wbr/>DEFAULT</span><a href="#WORKER_DIST_PATH_DEFAULT" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">WORKER_<wbr/>DIST_<wbr/>PATH_<wbr/>DEFAULT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = ...</span></div></section>
<section class="tsd-panel tsd-member"><a id="WORKER_LOADER" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>WORKER_<wbr/>LOADER</span><a href="#WORKER_LOADER" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">WORKER_<wbr/>LOADER</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = undefined</span></div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="WORKER_LOADER.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Worker</span></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4></li></ul></li></ul></div></section>
<section class="tsd-panel tsd-member"><a id="WORKER_OBJECTS" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>WORKER_<wbr/>OBJECTS</span><a href="#WORKER_OBJECTS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">WORKER_<wbr/>OBJECTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div></section></section>
Expand Down Expand Up @@ -242,23 +254,13 @@ <h5><span class="tsd-kind-parameter">fnId</span>: <span class="tsd-signature-typ
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></section>
<section class="tsd-panel tsd-member"><a id="loadFullModule" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>load<wbr/>Full<wbr/>Module</span><a href="#loadFullModule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<section class="tsd-panel tsd-member"><a id="loadWasmModule" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>load<wbr/>Wasm<wbr/>Module</span><a href="#loadWasmModule" 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="loadFullModule.loadFullModule-1"><span class="tsd-kind-call-signature">load<wbr/>Full<wbr/>Module</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#loadFullModule.loadFullModule-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-signature tsd-anchor-link" id="loadWasmModule.loadWasmModule-1"><span class="tsd-kind-call-signature">load<wbr/>Wasm<wbr/>Module</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#loadWasmModule.loadWasmModule-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>Load the WebAssembly full module with caching.</p>
<p>The full module is a superset of the keys module and overrides it.</p>
<p>TODO: this is separate static function from loadKeysModule() because webpack cannot bundle worker using runtime param for conditional import</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></section>
<section class="tsd-panel tsd-member"><a id="loadKeysModule" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>load<wbr/>Keys<wbr/>Module</span><a href="#loadKeysModule" 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="loadKeysModule.loadKeysModule-1"><span class="tsd-kind-call-signature">load<wbr/>Keys<wbr/>Module</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#loadKeysModule.loadKeysModule-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>Load the WebAssembly keys module with caching.</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></section>
Expand Down Expand Up @@ -397,7 +399,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="setWorkerDistPath.setWorkerDistPath-1"><span class="tsd-kind-call-signature">set<wbr/>Worker<wbr/>Dist<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerDistPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setWorkerDistPath.setWorkerDistPath-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>Set the path to load the worker. Defaults to &quot;/monero_web_worker.js&quot; in the browser
<div class="tsd-comment tsd-typography"><p>Set the path to load the worker. Defaults to &quot;/monero.worker.js&quot; in the browser
and &quot;./MoneroWebWorker.js&quot; in node.</p>
</div>
<div class="tsd-parameters">
Expand All @@ -410,6 +412,31 @@ <h5><span class="tsd-kind-parameter">workerDistPath</span>: <span class="tsd-sig
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></section>
<section class="tsd-panel tsd-member"><a id="setWorkerLoader" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Worker<wbr/>Loader</span><a href="#setWorkerLoader" 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="setWorkerLoader.setWorkerLoader-1"><span class="tsd-kind-call-signature">set<wbr/>Worker<wbr/>Loader</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">loader</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setWorkerLoader.setWorkerLoader-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>Set the worker loader closure to customize worker loading.
Takes precedence over default loading mechanisms.</p>
<p>Could be as simple as <code>() =&gt; new Worker(new URL(&quot;monero-ts/dist/monero.worker.js&quot;, import.meta.url));</code> for browsers.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">loader</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">)</span></h5>
<div class="tsd-comment tsd-typography"><p>loader function which instantiates a worker</p>
</div>
<div class="tsd-comment tsd-typography"></div>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Worker</span></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4></li></ul></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></section>
<section class="tsd-panel tsd-member"><a id="terminateWorker" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>terminate<wbr/>Worker</span><a href="#terminateWorker" 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 @@ -446,6 +473,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#WORKER" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER</span></a></li>
<li><a href="#WORKER_DIST_PATH" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER_<wbr/>DIST_<wbr/>PATH</span></a></li>
<li><a href="#WORKER_DIST_PATH_DEFAULT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER_<wbr/>DIST_<wbr/>PATH_<wbr/>DEFAULT</span></a></li>
<li><a href="#WORKER_LOADER" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER_<wbr/>LOADER</span></a></li>
<li><a href="#WORKER_OBJECTS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>WORKER_<wbr/>OBJECTS</span></a></li>
<li><a href="#addWorkerCallback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Worker<wbr/>Callback</span></a></li>
<li><a href="#deserializeError" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>deserialize<wbr/>Error</span></a></li>
Expand All @@ -457,8 +485,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#initWasmModule" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>init<wbr/>Wasm<wbr/>Module</span></a></li>
<li><a href="#invokeWorker" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>invoke<wbr/>Worker</span></a></li>
<li><a href="#isRejectUnauthorized" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Reject<wbr/>Unauthorized</span></a></li>
<li><a href="#loadFullModule" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>Full<wbr/>Module</span></a></li>
<li><a href="#loadKeysModule" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>Keys<wbr/>Module</span></a></li>
<li><a href="#loadWasmModule" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>Wasm<wbr/>Module</span></a></li>
<li><a href="#log" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>log</span></a></li>
<li><a href="#prefixWindowsPath" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prefix<wbr/>Windows<wbr/>Path</span></a></li>
<li><a href="#queueTask" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>queue<wbr/>Task</span></a></li>
Expand All @@ -468,6 +495,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#setLogLevel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Log<wbr/>Level</span></a></li>
<li><a href="#setRejectUnauthorizedFn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Reject<wbr/>Unauthorized<wbr/>Fn</span></a></li>
<li><a href="#setWorkerDistPath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Dist<wbr/>Path</span></a></li>
<li><a href="#setWorkerLoader" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Loader</span></a></li>
<li><a href="#terminateWorker" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>terminate<wbr/>Worker</span></a></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>monero-ts</span></a>
Expand Down
Loading

0 comments on commit 0818364

Please sign in to comment.