Skip to main content
Worker.prototype.send - cluster - Node documentation
method Worker.prototype.send

Usage in Deno

import { Worker } from "node:cluster";
Worker.prototype.send(
message: child.Serializable,
callback?: (error: Error | null) => void,
): boolean

Send a message to a worker or primary, optionally with a handle.

In the primary, this sends a message to a specific worker. It is identical to ChildProcess.send().

In a worker, this sends a message to the primary. It is identical to process.send().

This example will echo back all messages from the primary:

if (cluster.isPrimary) {
  const worker = cluster.fork();
  worker.send('hi there');

} else if (cluster.isWorker) {
  process.on('message', (msg) => {
    process.send(msg);
  });
}

Parameters

message: child.Serializable
optional
callback: (error: Error | null) => void

Return Type

boolean
Worker.prototype.send(
message: child.Serializable,
sendHandle: child.SendHandle,
callback?: (error: Error | null) => void,
): boolean

Parameters

message: child.Serializable
sendHandle: child.SendHandle
optional
callback: (error: Error | null) => void

Return Type

boolean
Worker.prototype.send(
message: child.Serializable,
sendHandle: child.SendHandle,
options?: child.MessageOptions,
callback?: (error: Error | null) => void,
): boolean

Parameters

message: child.Serializable
sendHandle: child.SendHandle
optional
options: child.MessageOptions
optional
callback: (error: Error | null) => void

Return Type

boolean
Back to top