Skip to content

Commit 6f77590

Browse files
committed
Updated docs
1 parent 867b409 commit 6f77590

3 files changed

Lines changed: 28 additions & 28 deletions

File tree

docs/classes/WorkerManager.default.html

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,13 @@ <h2>Constructors</h2>
136136
<a name="constructor" class="tsd-anchor"></a>
137137
<h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
138138
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-protected">
139-
<li class="tsd-signature tsd-kind-icon">new default&lt;W&gt;<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>cores<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>logger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Logger</span><span class="tsd-signature-symbol">; </span>workerFactory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WorkerManager.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">W</span><span class="tsd-signature-symbol">&gt;</span></li>
139+
<li class="tsd-signature tsd-kind-icon">new default&lt;W&gt;<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>cores<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>logger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Logger</span><span class="tsd-signature-symbol">; </span>workerFactory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WorkerManager.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">W</span><span class="tsd-signature-symbol">&gt;</span></li>
140140
</ul>
141141
<ul class="tsd-descriptions">
142142
<li class="tsd-description">
143143
<aside class="tsd-sources">
144144
<ul>
145-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L45">src/WorkerManager.ts:45</a></li>
145+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L45">src/WorkerManager.ts:45</a></li>
146146
</ul>
147147
</aside>
148148
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -154,13 +154,13 @@ <h4>W<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type
154154
<h4 class="tsd-parameters-title">Parameters</h4>
155155
<ul class="tsd-parameters">
156156
<li>
157-
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>cores<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>logger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Logger</span><span class="tsd-signature-symbol">; </span>workerFactory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
157+
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>cores<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>logger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Logger</span><span class="tsd-signature-symbol">; </span>workerFactory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
158158
<ul class="tsd-parameters">
159159
<li class="tsd-parameter">
160160
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cores<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
161161
</li>
162162
<li class="tsd-parameter">
163-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> logger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Logger</span></h5>
163+
<h5>logger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Logger</span></h5>
164164
</li>
165165
<li class="tsd-parameter">
166166
<h5>worker<wbr>Factory<span class="tsd-signature-symbol">: </span>function</h5>
@@ -171,7 +171,7 @@ <h5>worker<wbr>Factory<span class="tsd-signature-symbol">: </span>function</h5>
171171
<li class="tsd-description">
172172
<aside class="tsd-sources">
173173
<ul>
174-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L50">src/WorkerManager.ts:50</a></li>
174+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L50">src/WorkerManager.ts:50</a></li>
175175
</ul>
176176
</aside>
177177
<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">ModuleThread</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">W</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -194,7 +194,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _destroyed</h3>
194194
<div class="tsd-signature tsd-kind-icon">_destroyed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
195195
<aside class="tsd-sources">
196196
<ul>
197-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L43">src/WorkerManager.ts:43</a></li>
197+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L43">src/WorkerManager.ts:43</a></li>
198198
</ul>
199199
</aside>
200200
</section>
@@ -204,7 +204,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _running</h3>
204204
<div class="tsd-signature tsd-kind-icon">_running<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
205205
<aside class="tsd-sources">
206206
<ul>
207-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L42">src/WorkerManager.ts:42</a></li>
207+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L42">src/WorkerManager.ts:42</a></li>
208208
</ul>
209209
</aside>
210210
</section>
@@ -214,7 +214,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> logger</h3>
214214
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span></div>
215215
<aside class="tsd-sources">
216216
<ul>
217-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L41">src/WorkerManager.ts:41</a></li>
217+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L41">src/WorkerManager.ts:41</a></li>
218218
</ul>
219219
</aside>
220220
</section>
@@ -224,7 +224,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> pool</h3>
224224
<div class="tsd-signature tsd-kind-icon">pool<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pool</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ModuleThread</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">W</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
225225
<aside class="tsd-sources">
226226
<ul>
227-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L40">src/WorkerManager.ts:40</a></li>
227+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L40">src/WorkerManager.ts:40</a></li>
228228
</ul>
229229
</aside>
230230
</section>
@@ -241,7 +241,7 @@ <h3>destroyed</h3>
241241
<li class="tsd-description">
242242
<aside class="tsd-sources">
243243
<ul>
244-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L63">src/WorkerManager.ts:63</a></li>
244+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L63">src/WorkerManager.ts:63</a></li>
245245
</ul>
246246
</aside>
247247
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
@@ -258,7 +258,7 @@ <h3>running</h3>
258258
<li class="tsd-description">
259259
<aside class="tsd-sources">
260260
<ul>
261-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L59">src/WorkerManager.ts:59</a></li>
261+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L59">src/WorkerManager.ts:59</a></li>
262262
</ul>
263263
</aside>
264264
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
@@ -279,7 +279,7 @@ <h3>call</h3>
279279
<aside class="tsd-sources">
280280
<p>Implementation of <a href="../interfaces/WorkerManagerInterface.default.html">default</a>.<a href="../interfaces/WorkerManagerInterface.default.html#call">call</a></p>
281281
<ul>
282-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L78">src/WorkerManager.ts:78</a></li>
282+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L78">src/WorkerManager.ts:78</a></li>
283283
</ul>
284284
</aside>
285285
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -327,7 +327,7 @@ <h3>completed</h3>
327327
<aside class="tsd-sources">
328328
<p>Implementation of <a href="../interfaces/WorkerManagerInterface.default.html">default</a>.<a href="../interfaces/WorkerManagerInterface.default.html#completed">completed</a></p>
329329
<ul>
330-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L94">src/WorkerManager.ts:94</a></li>
330+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L94">src/WorkerManager.ts:94</a></li>
331331
</ul>
332332
</aside>
333333
<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>
@@ -345,7 +345,7 @@ <h3>destroy</h3>
345345
<aside class="tsd-sources">
346346
<p>Implementation of <a href="../interfaces/WorkerManagerInterface.default.html">default</a>.<a href="../interfaces/WorkerManagerInterface.default.html#destroy">destroy</a></p>
347347
<ul>
348-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L67">src/WorkerManager.ts:67</a></li>
348+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L67">src/WorkerManager.ts:67</a></li>
349349
</ul>
350350
</aside>
351351
<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>
@@ -363,7 +363,7 @@ <h3>queue</h3>
363363
<aside class="tsd-sources">
364364
<p>Implementation of <a href="../interfaces/WorkerManagerInterface.default.html">default</a>.<a href="../interfaces/WorkerManagerInterface.default.html#queue">queue</a></p>
365365
<ul>
366-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L85">src/WorkerManager.ts:85</a></li>
366+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L85">src/WorkerManager.ts:85</a></li>
367367
</ul>
368368
</aside>
369369
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -411,7 +411,7 @@ <h3>settled</h3>
411411
<aside class="tsd-sources">
412412
<p>Implementation of <a href="../interfaces/WorkerManagerInterface.default.html">default</a>.<a href="../interfaces/WorkerManagerInterface.default.html#settled">settled</a></p>
413413
<ul>
414-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L101">src/WorkerManager.ts:101</a></li>
414+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L101">src/WorkerManager.ts:101</a></li>
415415
</ul>
416416
</aside>
417417
<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">Error</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -428,7 +428,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Worker<wbr>Man
428428
<li class="tsd-description">
429429
<aside class="tsd-sources">
430430
<ul>
431-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L23">src/WorkerManager.ts:23</a></li>
431+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L23">src/WorkerManager.ts:23</a></li>
432432
</ul>
433433
</aside>
434434
<div class="tsd-comment tsd-typography">
@@ -469,7 +469,7 @@ <h5>worker<wbr>Factory<span class="tsd-signature-symbol">: </span>function</h5>
469469
<li class="tsd-description">
470470
<aside class="tsd-sources">
471471
<ul>
472-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L28">src/WorkerManager.ts:28</a></li>
472+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManager.ts#L28">src/WorkerManager.ts:28</a></li>
473473
</ul>
474474
</aside>
475475
<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">ModuleThread</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">W</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>

docs/interfaces/WorkerManagerInterface.default.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h3>call</h3>
119119
<li class="tsd-description">
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManagerInterface.ts#L7">src/WorkerManagerInterface.ts:7</a></li>
122+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManagerInterface.ts#L7">src/WorkerManagerInterface.ts:7</a></li>
123123
</ul>
124124
</aside>
125125
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -166,7 +166,7 @@ <h3>completed</h3>
166166
<li class="tsd-description">
167167
<aside class="tsd-sources">
168168
<ul>
169-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManagerInterface.ts#L11">src/WorkerManagerInterface.ts:11</a></li>
169+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManagerInterface.ts#L11">src/WorkerManagerInterface.ts:11</a></li>
170170
</ul>
171171
</aside>
172172
<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>
@@ -183,7 +183,7 @@ <h3>destroy</h3>
183183
<li class="tsd-description">
184184
<aside class="tsd-sources">
185185
<ul>
186-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManagerInterface.ts#L6">src/WorkerManagerInterface.ts:6</a></li>
186+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManagerInterface.ts#L6">src/WorkerManagerInterface.ts:6</a></li>
187187
</ul>
188188
</aside>
189189
<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>
@@ -200,7 +200,7 @@ <h3>queue</h3>
200200
<li class="tsd-description">
201201
<aside class="tsd-sources">
202202
<ul>
203-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManagerInterface.ts#L8">src/WorkerManagerInterface.ts:8</a></li>
203+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManagerInterface.ts#L8">src/WorkerManagerInterface.ts:8</a></li>
204204
</ul>
205205
</aside>
206206
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -247,7 +247,7 @@ <h3>settled</h3>
247247
<li class="tsd-description">
248248
<aside class="tsd-sources">
249249
<ul>
250-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManagerInterface.ts#L12">src/WorkerManagerInterface.ts:12</a></li>
250+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/867b409/src/WorkerManagerInterface.ts#L12">src/WorkerManagerInterface.ts:12</a></li>
251251
</ul>
252252
</aside>
253253
<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">Error</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>

0 commit comments

Comments
 (0)