Worker

external class Worker : EventEmitter(source)

The Worker class represents an independent JavaScript execution thread. Most Node.js APIs are available inside of it.

Notable differences inside a Worker environment are:

The process.stdin, process.stdout, and process.stderr streams may be redirected by the parent thread.
The import { isMainThread } from 'node:worker_threads' variable is set to false.
The import { parentPort } from 'node:worker_threads' message port is available.
process.exit() does not stop the whole program, just the single thread, and process.abort() is not available.
process.chdir() and process methods that set group or user ids are not available.
process.env is a copy of the parent thread's environment variables, unless otherwise specified. Changes to one copy are not visible in other threads, and are not visible to native add-ons (unless worker.SHARE_ENV is passed as the env option to the Worker constructor). On Windows, unlike the main thread, a copy of the environment variables operates in a case-sensitive manner.
process.title cannot be modified.
Signals are not delivered through process.on('...').
Execution may stop at any point as a result of worker.terminate() being invoked.
IPC channels from parent processes are not accessible.
The trace_events module is not supported.
Native add-ons can only be loaded from multiple threads if they fulfill certain conditions.

Creating Worker instances inside of other Workers is possible.

Like Web Workers and the node:cluster module, two-way communication can be achieved through inter-thread message passing. Internally, a Worker has a built-in pair of MessagePort s that are already associated with each other when the Worker is created. While the MessagePort object on the parent side is not directly exposed, its functionalities are exposed through worker.postMessage() and the worker.on('message') event on the Worker object for the parent thread.

To create custom messaging channels (which is encouraged over using the default global channel because it facilitates separation of concerns), users can create a MessageChannel object on either thread and pass one of theMessagePorts on that MessageChannel to the other thread through a pre-existing channel, such as the global one.

See port.postMessage() for more information on how messages are passed, and what kind of JavaScript values can be successfully transported through the thread barrier.

import assert from 'node:assert';
import {
  Worker, MessageChannel, MessagePort, isMainThread, parentPort,
} from 'node:worker_threads';
if (isMainThread) {
  const worker = new Worker(__filename);
  const subChannel = new MessageChannel();
  worker.postMessage({ hereIsYourPort: subChannel.port1 }, [subChannel.port1]);
  subChannel.port2.on('message', (value) => {
    console.log('received:', value);
  });
} else {
  parentPort.once('message', (value) => {
    assert(value.hereIsYourPort instanceof MessagePort);
    value.hereIsYourPort.postMessage('the worker is sending this');
    value.hereIsYourPort.close();
  });
}

Since

v10.5.0

Constructors

Worker

constructor(filename: String, options: WorkerOptions = definedExternally)

constructor(filename: ERROR CLASS: Symbol not found for URL, options: WorkerOptions = definedExternally)

Properties

errorEvent

val errorEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<ERROR CLASS: Symbol not found for js.errors.JsError>>

exitEvent

val exitEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<kotlin/Double>>

messageerrorEvent

val messageerrorEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<ERROR CLASS: Symbol not found for js.errors.JsError>>

messageEvent

val messageEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<kotlin/Any?>>

onlineEvent

val onlineEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple>

performance

val performance: WorkerPerformance

An object that can be used to query performance information from a worker instance. Similar to perf_hooks.performance.

resourceLimits

val resourceLimits: ResourceLimits?

Provides the set of JS engine resource constraints for this Worker thread. If the resourceLimits option was passed to the Worker constructor, this matches its values.

stderr

val stderr: Readable

This is a readable stream which contains data written to process.stderr inside the worker thread. If stderr: true was not passed to the Worker constructor, then data is piped to the parent thread's process.stderr stream.

stdin

val stdin: Writable?

If stdin: true was passed to the Worker constructor, this is a writable stream. The data written to this stream will be made available in the worker thread as process.stdin.

stdout

val stdout: Readable

This is a readable stream which contains data written to process.stdout inside the worker thread. If stdout: true was not passed to the Worker constructor, then data is piped to the parent thread's process.stdout stream.

threadId

val threadId: Double

An integer identifier for the referenced thread. Inside the worker thread, it is available as import { threadId } from 'node:worker_threads'. This value is unique for each Worker instance inside a single process.

threadName

val threadName: String?

A string identifier for the referenced thread or null if the thread is not running. Inside the worker thread, it is available as require('node:worker_threads').threadName.

Functions

addListener

fun addListener(type: EventType, listener: EventListener)

Alias for emitter.on(eventName, listener).

fun addListener(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

fun addListener(event: String, listener: Function<Unit>)

cpuUsage

suspend fun cpuUsage(prev: CpuUsage = definedExternally): CpuUsage

cpuUsageAsync

fun cpuUsageAsync(prev: CpuUsage = definedExternally): ERROR CLASS: Symbol not found for Promise<node/process/CpuUsage>

This method returns a Promise that will resolve to an object identical to process.threadCpuUsage(), or reject with an ERR_WORKER_NOT_RUNNING error if the worker is no longer running. This methods allows the statistics to be observed from outside the actual thread.

emit

fun emit(type: EventType, vararg args: Any?): Boolean

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

fun emit(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, vararg args: Any?): Boolean

fun emit(event: String, vararg args: Any?): Boolean

eventNames

fun eventNames(): Array<EventType>

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

getHeapSnapshot

suspend fun getHeapSnapshot(): Readable

getHeapSnapshotAsync

fun getHeapSnapshotAsync(): ERROR CLASS: Symbol not found for Promise<node/stream/Readable>

Returns a readable stream for a V8 snapshot of the current state of the Worker. See v8.getHeapSnapshot() for more details.

getHeapStatistics

suspend fun getHeapStatistics(): HeapInfo

getHeapStatisticsAsync

fun getHeapStatisticsAsync(): ERROR CLASS: Symbol not found for Promise<node/v8/HeapInfo>

This method returns a Promise that will resolve to an object identical to v8.getHeapStatistics(), or reject with an ERR_WORKER_NOT_RUNNING error if the worker is no longer running. This methods allows the statistics to be observed from outside the actual thread.

getMaxListeners

fun getMaxListeners(): Double

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link EventEmitter.defaultMaxListeners}.

listenerCount

fun listenerCount(type: EventType, listener: EventListener = definedExternally): Double

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

listeners

fun listeners(type: EventType): Array<EventListener>

Returns a copy of the array of listeners for the event named eventName.

off

fun off(type: EventType, listener: EventListener)

Alias for emitter.removeListener().

fun off(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

fun off(event: String, listener: Function<Unit>)

fun on(type: EventType, listener: EventListener)

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

fun on(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

fun on(event: String, listener: Function<Unit>)

once

fun once(type: EventType, listener: EventListener)

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

fun once(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

fun once(event: String, listener: Function<Unit>)

postMessage

fun postMessage(value: Any?, transferList: ERROR CLASS: Symbol not found for ReadonlyArray<{node/workerThreads/Transferable=} kotlin/Any> = definedExternally)

Send a message to the worker that is received via require('node:worker_threads').parentPort.on('message'). See port.postMessage() for more details.

prependListener

fun prependListener(type: EventType, listener: EventListener)

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

fun prependListener(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

fun prependListener(event: String, listener: Function<Unit>)

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

fun prependOnceListener(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

fun prependOnceListener(event: String, listener: Function<Unit>)

rawListeners

fun rawListeners(type: EventType): Array<EventListener>

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

ref

fun ref()

Opposite of unref(), calling ref() on a previously unref()ed worker does not let the program exit if it's the only active handle left (the default behavior). If the worker is ref()ed, calling ref() again has no effect.

removeAllListeners

fun removeAllListeners(type: EventType = definedExternally)

Removes all listeners, or those of the specified eventName.

removeListener

fun removeListener(type: EventType, listener: EventListener)

Removes the specified listener from the listener array for the event named eventName.

fun removeListener(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

fun removeListener(event: String, listener: Function<Unit>)

setMaxListeners

fun setMaxListeners(n: Number)

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

terminate

suspend fun terminate(): Double

terminateAsync

fun terminateAsync(): ERROR CLASS: Symbol not found for Promise<kotlin/Double>

Stop all JavaScript execution in the worker thread as soon as possible. Returns a Promise for the exit code that is fulfilled when the 'exit' event is emitted.

unref

fun unref()

Calling unref() on a worker allows the thread to exit if this is the only active handle in the event system. If the worker is already unref()ed calling unref() again has no effect.