Skip to content

Commit eec4ea2

Browse files
CMCDragonkaiCMCDragonkai
committed
Lintfixed and removed comments
1 parent 547e4f7 commit eec4ea2

6 files changed

Lines changed: 69 additions & 88 deletions

File tree

‎benches/WorkerManager.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ const logger = new Logger('WorkerManager Bench', LogLevel.WARN, [
1515
async function main() {
1616
const cores = os.cpus().length;
1717
logger.warn(`Cores: ${cores}`);
18-
const workerManager = await WorkerManager.createWorkerManager({
18+
const workerManager = await WorkerManager.createWorkerManager<WorkerModule>({
1919
workerFactory: () => spawn(new Worker('../src/worker')),
2020
cores,
21-
logger
21+
logger,
2222
});
2323
// 1 MiB worth of data is the ballpark range of data to be worth parallelising
2424
// 1 KiB of data is still too small

‎docs/classes/WorkerManager.default.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
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/daa24c5/src/WorkerManager.ts#L45">src/WorkerManager.ts:45</a></li>
145+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/WorkerManager.ts#L45">src/WorkerManager.ts:45</a></li>
146146
</ul>
147147
</aside>
148148
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -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/daa24c5/src/WorkerManager.ts#L50">src/WorkerManager.ts:50</a></li>
174+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L43">src/WorkerManager.ts:43</a></li>
197+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L42">src/WorkerManager.ts:42</a></li>
207+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L41">src/WorkerManager.ts:41</a></li>
217+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L40">src/WorkerManager.ts:40</a></li>
227+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L63">src/WorkerManager.ts:63</a></li>
244+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L59">src/WorkerManager.ts:59</a></li>
261+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L109">src/WorkerManager.ts:109</a></li>
282+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L125">src/WorkerManager.ts:125</a></li>
330+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L98">src/WorkerManager.ts:98</a></li>
348+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L116">src/WorkerManager.ts:116</a></li>
366+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L132">src/WorkerManager.ts:132</a></li>
414+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L23">src/WorkerManager.ts:23</a></li>
431+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManager.ts#L28">src/WorkerManager.ts:28</a></li>
472+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManagerInterface.ts#L7">src/WorkerManagerInterface.ts:7</a></li>
122+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManagerInterface.ts#L11">src/WorkerManagerInterface.ts:11</a></li>
169+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManagerInterface.ts#L6">src/WorkerManagerInterface.ts:6</a></li>
186+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManagerInterface.ts#L8">src/WorkerManagerInterface.ts:8</a></li>
203+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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/daa24c5/src/WorkerManagerInterface.ts#L12">src/WorkerManagerInterface.ts:12</a></li>
250+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/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>

‎docs/modules/workerModule.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ <h3>Worker<wbr>Module</h3>
9292
<div class="tsd-signature tsd-kind-icon">Worker<wbr>Module<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="workerModule.html#default" class="tsd-signature-type" data-tsd-kind="Variable">default</a></div>
9393
<aside class="tsd-sources">
9494
<ul>
95-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/daa24c5/src/workerModule.ts#L43">src/workerModule.ts:43</a></li>
95+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/workerModule.ts#L43">src/workerModule.ts:43</a></li>
9696
</ul>
9797
</aside>
9898
</section>
@@ -105,7 +105,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> default</h3>
105105
<div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>isRunningInWorker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sleep<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>transferBuffer<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></div>
106106
<aside class="tsd-sources">
107107
<ul>
108-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/daa24c5/src/workerModule.ts#L12">src/workerModule.ts:12</a></li>
108+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/workerModule.ts#L12">src/workerModule.ts:12</a></li>
109109
</ul>
110110
</aside>
111111
<div class="tsd-comment tsd-typography">
@@ -129,7 +129,7 @@ <h5>is<wbr>Running<wbr>InWorker<span class="tsd-signature-symbol">: </span>funct
129129
<li class="tsd-description">
130130
<aside class="tsd-sources">
131131
<ul>
132-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/daa24c5/src/workerModule.ts#L17">src/workerModule.ts:17</a></li>
132+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/workerModule.ts#L17">src/workerModule.ts:17</a></li>
133133
</ul>
134134
</aside>
135135
<div class="tsd-comment tsd-typography">
@@ -151,7 +151,7 @@ <h5>sleep<span class="tsd-signature-symbol">: </span>function</h5>
151151
<li class="tsd-description">
152152
<aside class="tsd-sources">
153153
<ul>
154-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/daa24c5/src/workerModule.ts#L25">src/workerModule.ts:25</a></li>
154+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/workerModule.ts#L25">src/workerModule.ts:25</a></li>
155155
</ul>
156156
</aside>
157157
<div class="tsd-comment tsd-typography">
@@ -180,7 +180,7 @@ <h5>transfer<wbr>Buffer<span class="tsd-signature-symbol">: </span>function</h5>
180180
<li class="tsd-description">
181181
<aside class="tsd-sources">
182182
<ul>
183-
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/daa24c5/src/workerModule.ts#L32">src/workerModule.ts:32</a></li>
183+
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/547e4f7/src/workerModule.ts#L32">src/workerModule.ts:32</a></li>
184184
</ul>
185185
</aside>
186186
<div class="tsd-comment tsd-typography">

‎src/WorkerManager.ts‎

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ class WorkerManager<W extends ModuleMethods>
2323
public static async createWorkerManager<W extends ModuleMethods>({
2424
workerFactory,
2525
cores,
26-
logger
26+
logger,
2727
}: {
2828
workerFactory: () => Promise<ModuleThread<W>>;
2929
cores?: number;
30-
logger?: Logger
30+
logger?: Logger;
3131
}): Promise<WorkerManager<W>> {
3232
const workerManager = new WorkerManager({
3333
workerFactory,
3434
cores,
35-
logger
35+
logger,
3636
});
3737
return workerManager;
3838
}
@@ -64,37 +64,6 @@ class WorkerManager<W extends ModuleMethods>
6464
return this._destroyed;
6565
}
6666

67-
// public async start({
68-
// workerFactory,
69-
// cores,
70-
// }: {
71-
// workerFactory: () => Promise<ModuleThread<W>>;
72-
// cores?: number;
73-
// }) {
74-
// try {
75-
// if (this._started) {
76-
// return;
77-
// }
78-
// this.logger.info('Starting WorkerManager');
79-
// this._started = true;
80-
// this.pool = Pool(workerFactory, cores);
81-
// this.logger.info(`Started WorkerManager`);
82-
// } catch (e) {
83-
// this._started = false;
84-
// throw e;
85-
// }
86-
// }
87-
88-
// public async stop() {
89-
// if (!this._started) {
90-
// return;
91-
// }
92-
// this.logger.info('Stopping WorkerManager');
93-
// await this.pool.terminate();
94-
// this._started = false;
95-
// this.logger.info('Stopped WorkerManager');
96-
// }
97-
9867
public async destroy(): Promise<void> {
9968
if (this._destroyed) {
10069
return;

0 commit comments

Comments
 (0)