Use the current node.js LTS version for publication. (#228)
[poolifier.git] / src / worker / thread-worker.ts
CommitLineData
838898f1 1import type { MessagePort } from 'worker_threads'
fa699c42 2import { isMainThread, parentPort } from 'worker_threads'
deb85c12 3import type { MessageValue } from '../utility-types'
c97c7edb 4import { AbstractWorker } from './abstract-worker'
325f50bc 5import type { WorkerOptions } from './worker-options'
a32e02ba 6
a32e02ba 7/**
729c563d 8 * A thread worker used by a poolifier `ThreadPool`.
4ade5f1f 9 *
729c563d
S
10 * When this worker is inactive for more than the given `maxInactiveTime`,
11 * it will send a termination request to its main thread.
12 *
13 * If you use a `DynamicThreadPool` the extra workers that were created will be terminated,
14 * but the minimum number of workers will be guaranteed.
15 *
deb85c12
JB
16 * @template Data Type of data this worker receives from pool's execution. This can only be serializable data.
17 * @template Response Type of response the worker sends back to the main thread. This can only be serializable data.
4ade5f1f
S
18 *
19 * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
a32e02ba 20 * @since 0.0.1
21 */
d3c8a1a8 22export class ThreadWorker<
deb85c12
JB
23 Data = unknown,
24 Response = unknown
d3c8a1a8 25> extends AbstractWorker<MessagePort, Data, Response> {
729c563d
S
26 /**
27 * Constructs a new poolifier thread worker.
28 *
29 * @param fn Function processed by the worker when the pool's `execution` function is invoked.
30 * @param opts Options for the worker.
31 */
c97c7edb 32 public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) {
838898f1 33 super('worker-thread-pool:pioardi', isMainThread, fn, parentPort, opts)
106744f7 34 }
7784f548 35
c97c7edb
S
36 protected sendToMainWorker (message: MessageValue<Response>): void {
37 this.getMainWorker().postMessage(message)
7784f548 38 }
a32e02ba 39}