Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated docs
Browse files Browse the repository at this point in the history
CMCDragonkai committed Apr 5, 2022
1 parent cd28c29 commit 9309c24
Showing 13 changed files with 384 additions and 193 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js

Large diffs are not rendered by default.

123 changes: 22 additions & 101 deletions docs/classes/WorkerManager.default.html

Large diffs are not rendered by default.

186 changes: 160 additions & 26 deletions docs/classes/errors.ErrorWorkerManager.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -180,11 +180,10 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
14 changes: 12 additions & 2 deletions docs/interfaces/WorkerManagerInterface.default.html
Original file line number Diff line number Diff line change
@@ -177,7 +177,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">destroy<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">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
@@ -186,6 +186,17 @@ <h3>destroy</h3>
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/master/src/WorkerManagerInterface.ts#L6">src/WorkerManagerInterface.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <span class="tsd-signature-symbol">{ </span>force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
</ul>
<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">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
@@ -326,7 +337,6 @@ <h2>Legend</h2>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
5 changes: 2 additions & 3 deletions docs/modules.html
Original file line number Diff line number Diff line change
@@ -118,11 +118,10 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
5 changes: 2 additions & 3 deletions docs/modules/WorkerManager.html
Original file line number Diff line number Diff line change
@@ -124,11 +124,10 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
5 changes: 2 additions & 3 deletions docs/modules/WorkerManagerInterface.html
Original file line number Diff line number Diff line change
@@ -124,11 +124,10 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
15 changes: 7 additions & 8 deletions docs/modules/errors.html
Original file line number Diff line number Diff line change
@@ -72,8 +72,8 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/errors.ErrorWorkerManagerNotRunning.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Not<wbr>Running</a></li>
<li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a></li>
<li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/errors.ErrorWorkerManagerDestroyed.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Destroyed</a></li>
</ul>
</section>
</div>
@@ -108,11 +108,11 @@ <h3>Classes</h3>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/errors.ErrorWorkerManagerNotRunning.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Not<wbr>Running</a>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="../classes/errors.ErrorWorkerManagerDestroyed.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Destroyed</a>
</li>
</ul>
</nav>
@@ -128,11 +128,10 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
5 changes: 2 additions & 3 deletions docs/modules/index.html
Original file line number Diff line number Diff line change
@@ -168,11 +168,10 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
5 changes: 2 additions & 3 deletions docs/modules/worker.html
Original file line number Diff line number Diff line change
@@ -132,11 +132,10 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
5 changes: 2 additions & 3 deletions docs/modules/workerModule.html
Original file line number Diff line number Diff line change
@@ -251,11 +251,10 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>

0 comments on commit 9309c24

Please sign in to comment.