cluster.default.Worker

interface Worker

• exitedAfterDisconnect: boolean

  This property is true if the worker exited due to .disconnect(). If the worker exited any other way, it is false. If the worker has not exited, it is undefined.

  The boolean worker.exitedAfterDisconnect allows distinguishing between voluntary and accidental exit, the primary may choose not to respawn a worker based on this value.

  cluster.on('exit', (worker, code, signal) => {
    if (worker.exitedAfterDisconnect === true) {
      console.log('Oh, it was just voluntary – no need to worry');
    }
  });
  
  // kill worker
  worker.kill();
  
• id: number

  Each new worker is given its own unique id, this id is stored in the id.

  While a worker is alive, this is the key that indexes it in cluster.workers.

• process: ChildProcess

  All workers are created using child_process.fork(), the returned object from this function is stored as .process. In a worker, the global process is stored.

  See: Child Process module.

  Workers will call process.exit(0) if the 'disconnect' event occurs on process and .exitedAfterDisconnect is not true. This protects against accidental disconnection.

• [events.captureRejectionSymbol](

  error: Error,

  event: string | symbol,

  ...args: any[]

  ): void;

  The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

  import { EventEmitter, captureRejectionSymbol } from 'node:events';
  
  class MyClass extends EventEmitter {
    constructor() {
      super({ captureRejections: true });
    }
  
    [captureRejectionSymbol](err, event, ...args) {
      console.log('rejection happened for', event, 'with', err, ...args);
      this.destroy(err);
    }
  
    destroy(err) {
      // Tear the resource down here.
    }
  }
  
• addListener<E extends keyof WorkerEventMap>(

  eventName: E,

  listener: (...args: WorkerEventMap[E]) => void

  ): this;

  Alias for emitter.on(eventName, listener).

  addListener(

  eventName: string | symbol,

  listener: (...args: any[]) => void

  ): this;

  Alias for emitter.on(eventName, listener).
• destroy(

  signal?: string

  ): void;
• disconnect(): this;

  In a worker, this function will close all servers, wait for the 'close' event on those servers, and then disconnect the IPC channel.

  In the primary, an internal message is sent to the worker causing it to call .disconnect() on itself.

  Causes .exitedAfterDisconnect to be set.

  After a server is closed, it will no longer accept new connections, but connections may be accepted by any other listening worker. Existing connections will be allowed to close as usual. When no more connections exist, see server.close(), the IPC channel to the worker will close allowing it to die gracefully.

  The above applies only to server connections, client connections are not automatically closed by workers, and disconnect does not wait for them to close before exiting.

  In a worker, process.disconnect exists, but it is not this function; it is disconnect().

  Because long living server connections may block workers from disconnecting, it may be useful to send a message, so application specific actions may be taken to close them. It also may be useful to implement a timeout, killing a worker if the 'disconnect' event has not been emitted after some time.

  import net from 'node:net';
  
  if (cluster.isPrimary) {
    const worker = cluster.fork();
    let timeout;
  
    worker.on('listening', (address) => {
      worker.send('shutdown');
      worker.disconnect();
      timeout = setTimeout(() => {
        worker.kill();
      }, 2000);
    });
  
    worker.on('disconnect', () => {
      clearTimeout(timeout);
    });
  
  } else if (cluster.isWorker) {
    const server = net.createServer((socket) => {
      // Connections never end
    });
  
    server.listen(8000);
  
    process.on('message', (msg) => {
      if (msg === 'shutdown') {
        // Initiate graceful close of any connections to server
      }
    });
  }
  

  @returns

  A reference to worker.

• emit<E extends keyof WorkerEventMap>(

  eventName: E,

  ...args: WorkerEventMap[E]

  ): 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.

  Returns true if the event had listeners, false otherwise.

  import { EventEmitter } from 'node:events';
  const myEmitter = new EventEmitter();
  
  // First listener
  myEmitter.on('event', function firstListener() {
    console.log('Helloooo! first listener');
  });
  // Second listener
  myEmitter.on('event', function secondListener(arg1, arg2) {
    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
  });
  // Third listener
  myEmitter.on('event', function thirdListener(...args) {
    const parameters = args.join(', ');
    console.log(`event with parameters ${parameters} in third listener`);
  });
  
  console.log(myEmitter.listeners('event'));
  
  myEmitter.emit('event', 1, 2, 3, 4, 5);
  
  // Prints:
  // [
  //   [Function: firstListener],
  //   [Function: secondListener],
  //   [Function: thirdListener]
  // ]
  // Helloooo! first listener
  // event with parameters 1, 2 in second listener
  // event with parameters 1, 2, 3, 4, 5 in third listener
  

  emit(

  eventName: string | symbol,

  ...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.

  Returns true if the event had listeners, false otherwise.

  import { EventEmitter } from 'node:events';
  const myEmitter = new EventEmitter();
  
  // First listener
  myEmitter.on('event', function firstListener() {
    console.log('Helloooo! first listener');
  });
  // Second listener
  myEmitter.on('event', function secondListener(arg1, arg2) {
    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
  });
  // Third listener
  myEmitter.on('event', function thirdListener(...args) {
    const parameters = args.join(', ');
    console.log(`event with parameters ${parameters} in third listener`);
  });
  
  console.log(myEmitter.listeners('event'));
  
  myEmitter.emit('event', 1, 2, 3, 4, 5);
  
  // Prints:
  // [
  //   [Function: firstListener],
  //   [Function: secondListener],
  //   [Function: thirdListener]
  // ]
  // Helloooo! first listener
  // event with parameters 1, 2 in second listener
  // event with parameters 1, 2, 3, 4, 5 in third listener
  
• eventNames(): string | symbol[];

  Returns an array listing the events for which the emitter has registered listeners.

  import { EventEmitter } from 'node:events';
  
  const myEE = new EventEmitter();
  myEE.on('foo', () => {});
  myEE.on('bar', () => {});
  
  const sym = Symbol('symbol');
  myEE.on(sym, () => {});
  
  console.log(myEE.eventNames());
  // Prints: [ 'foo', 'bar', Symbol(symbol) ]
  
• getMaxListeners(): number;

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

• isConnected(): boolean;

  This function returns true if the worker is connected to its primary via its IPC channel, false otherwise. A worker is connected to its primary after it has been created. It is disconnected after the 'disconnect' event is emitted.

• isDead(): boolean;

  This function returns true if the worker's process has terminated (either because of exiting or being signaled). Otherwise, it returns false.

  import cluster from 'node:cluster';
  import http from 'node:http';
  import { availableParallelism } from 'node:os';
  import process from 'node:process';
  
  const numCPUs = availableParallelism();
  
  if (cluster.isPrimary) {
    console.log(`Primary ${process.pid} is running`);
  
    // Fork workers.
    for (let i = 0; i < numCPUs; i++) {
      cluster.fork();
    }
  
    cluster.on('fork', (worker) => {
      console.log('worker is dead:', worker.isDead());
    });
  
    cluster.on('exit', (worker, code, signal) => {
      console.log('worker is dead:', worker.isDead());
    });
  } else {
    // Workers can share any TCP connection. In this case, it is an HTTP server.
    http.createServer((req, res) => {
      res.writeHead(200);
      res.end(`Current process\n ${process.pid}`);
      process.kill(process.pid);
    }).listen(8000);
  }
  
• kill(

  signal?: string

  ): void;

  This function will kill the worker. In the primary worker, it does this by disconnecting the worker.process, and once disconnected, killing with signal. In the worker, it does it by killing the process with signal.

  The kill() function kills the worker process without waiting for a graceful disconnect, it has the same behavior as worker.process.kill().

  This method is aliased as worker.destroy() for backwards compatibility.

  In a worker, process.kill() exists, but it is not this function; it is kill().

  @param signal

  Name of the kill signal to send to the worker process.

• listenerCount<E extends keyof WorkerEventMap>(

  eventName: E,

  listener?: (...args: WorkerEventMap[E]) => void

  ): number;

  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.

  @param eventName

  The name of the event being listened for

  @param listener

  The event handler function

  listenerCount(

  eventName: string | symbol,

  listener?: (...args: any[]) => void

  ): number;

  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.

  @param eventName

  The name of the event being listened for

  @param listener

  The event handler function

• listeners<E extends keyof WorkerEventMap>(

  eventName: E

  ): (...args: WorkerEventMap[E]) => void[];

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

  server.on('connection', (stream) => {
    console.log('someone connected!');
  });
  console.log(util.inspect(server.listeners('connection')));
  // Prints: [ [Function] ]
  

  listeners(

  eventName: string | symbol

  ): (...args: any[]) => void[];

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

  server.on('connection', (stream) => {
    console.log('someone connected!');
  });
  console.log(util.inspect(server.listeners('connection')));
  // Prints: [ [Function] ]
  
• off<E extends keyof WorkerEventMap>(

  eventName: E,

  listener: (...args: WorkerEventMap[E]) => void

  ): this;

  Alias for emitter.removeListener().

  off(

  eventName: string | symbol,

  listener: (...args: any[]) => void

  ): this;

  Alias for emitter.removeListener().
• on<E extends keyof WorkerEventMap>(

  eventName: E,

  listener: (...args: WorkerEventMap[E]) => void

  ): this;

  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.

  server.on('connection', (stream) => {
    console.log('someone connected!');
  });
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

  import { EventEmitter } from 'node:events';
  const myEE = new EventEmitter();
  myEE.on('foo', () => console.log('a'));
  myEE.prependListener('foo', () => console.log('b'));
  myEE.emit('foo');
  // Prints:
  //   b
  //   a
  

  @param eventName

  The name of the event.

  @param listener

  The callback function

  on(

  eventName: string | symbol,

  listener: (...args: any[]) => void

  ): this;

  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.

  server.on('connection', (stream) => {
    console.log('someone connected!');
  });
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

  import { EventEmitter } from 'node:events';
  const myEE = new EventEmitter();
  myEE.on('foo', () => console.log('a'));
  myEE.prependListener('foo', () => console.log('b'));
  myEE.emit('foo');
  // Prints:
  //   b
  //   a
  

  @param eventName

  The name of the event.

  @param listener

  The callback function

• once<E extends keyof WorkerEventMap>(

  eventName: E,

  listener: (...args: WorkerEventMap[E]) => void

  ): this;

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

  server.once('connection', (stream) => {
    console.log('Ah, we have our first user!');
  });
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

  import { EventEmitter } from 'node:events';
  const myEE = new EventEmitter();
  myEE.once('foo', () => console.log('a'));
  myEE.prependOnceListener('foo', () => console.log('b'));
  myEE.emit('foo');
  // Prints:
  //   b
  //   a
  

  @param eventName

  The name of the event.

  @param listener

  The callback function

  once(

  eventName: string | symbol,

  listener: (...args: any[]) => void

  ): this;

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

  server.once('connection', (stream) => {
    console.log('Ah, we have our first user!');
  });
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

  import { EventEmitter } from 'node:events';
  const myEE = new EventEmitter();
  myEE.once('foo', () => console.log('a'));
  myEE.prependOnceListener('foo', () => console.log('b'));
  myEE.emit('foo');
  // Prints:
  //   b
  //   a
  

  @param eventName

  The name of the event.

  @param listener

  The callback function

• prependListener<E extends keyof WorkerEventMap>(

  eventName: E,

  listener: (...args: WorkerEventMap[E]) => void

  ): this;

  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.

  server.prependListener('connection', (stream) => {
    console.log('someone connected!');
  });
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  @param eventName

  The name of the event.

  @param listener

  The callback function

  prependListener(

  eventName: string | symbol,

  listener: (...args: any[]) => void

  ): this;

  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.

  server.prependListener('connection', (stream) => {
    console.log('someone connected!');
  });
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  @param eventName

  The name of the event.

  @param listener

  The callback function

• prependOnceListener<E extends keyof WorkerEventMap>(

  eventName: E,

  listener: (...args: WorkerEventMap[E]) => void

  ): this;

  Adds a one-time listener 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.

  server.prependOnceListener('connection', (stream) => {
    console.log('Ah, we have our first user!');
  });
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  @param eventName

  The name of the event.

  @param listener

  The callback function

  prependOnceListener(

  eventName: string | symbol,

  listener: (...args: any[]) => void

  ): this;

  Adds a one-time listener 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.

  server.prependOnceListener('connection', (stream) => {
    console.log('Ah, we have our first user!');
  });
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  @param eventName

  The name of the event.

  @param listener

  The callback function

• rawListeners<E extends keyof WorkerEventMap>(

  eventName: E

  ): (...args: WorkerEventMap[E]) => void[];

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

  import { EventEmitter } from 'node:events';
  const emitter = new EventEmitter();
  emitter.once('log', () => console.log('log once'));
  
  // Returns a new Array with a function `onceWrapper` which has a property
  // `listener` which contains the original listener bound above
  const listeners = emitter.rawListeners('log');
  const logFnWrapper = listeners[0];
  
  // Logs "log once" to the console and does not unbind the `once` event
  logFnWrapper.listener();
  
  // Logs "log once" to the console and removes the listener
  logFnWrapper();
  
  emitter.on('log', () => console.log('log persistently'));
  // Will return a new Array with a single function bound by `.on()` above
  const newListeners = emitter.rawListeners('log');
  
  // Logs "log persistently" twice
  newListeners[0]();
  emitter.emit('log');
  

  rawListeners(

  eventName: string | symbol

  ): (...args: any[]) => void[];

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

  import { EventEmitter } from 'node:events';
  const emitter = new EventEmitter();
  emitter.once('log', () => console.log('log once'));
  
  // Returns a new Array with a function `onceWrapper` which has a property
  // `listener` which contains the original listener bound above
  const listeners = emitter.rawListeners('log');
  const logFnWrapper = listeners[0];
  
  // Logs "log once" to the console and does not unbind the `once` event
  logFnWrapper.listener();
  
  // Logs "log once" to the console and removes the listener
  logFnWrapper();
  
  emitter.on('log', () => console.log('log persistently'));
  // Will return a new Array with a single function bound by `.on()` above
  const newListeners = emitter.rawListeners('log');
  
  // Logs "log persistently" twice
  newListeners[0]();
  emitter.emit('log');
  
• removeAllListeners<E extends keyof WorkerEventMap>(

  eventName?: E

  ): this;

  Removes all listeners, or those of the specified eventName.

  It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

  Returns a reference to the EventEmitter, so that calls can be chained.

  removeAllListeners(

  eventName?: string | symbol

  ): this;

  Removes all listeners, or those of the specified eventName.

  It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

  Returns a reference to the EventEmitter, so that calls can be chained.
• removeListener<E extends keyof WorkerEventMap>(

  eventName: E,

  listener: (...args: WorkerEventMap[E]) => void

  ): this;

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

  const callback = (stream) => {
    console.log('someone connected!');
  };
  server.on('connection', callback);
  // ...
  server.removeListener('connection', callback);
  

  removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

  Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

  import { EventEmitter } from 'node:events';
  class MyEmitter extends EventEmitter {}
  const myEmitter = new MyEmitter();
  
  const callbackA = () => {
    console.log('A');
    myEmitter.removeListener('event', callbackB);
  };
  
  const callbackB = () => {
    console.log('B');
  };
  
  myEmitter.on('event', callbackA);
  
  myEmitter.on('event', callbackB);
  
  // callbackA removes listener callbackB but it will still be called.
  // Internal listener array at time of emit [callbackA, callbackB]
  myEmitter.emit('event');
  // Prints:
  //   A
  //   B
  
  // callbackB is now removed.
  // Internal listener array [callbackA]
  myEmitter.emit('event');
  // Prints:
  //   A
  

  Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

  When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

  import { EventEmitter } from 'node:events';
  const ee = new EventEmitter();
  
  function pong() {
    console.log('pong');
  }
  
  ee.on('ping', pong);
  ee.once('ping', pong);
  ee.removeListener('ping', pong);
  
  ee.emit('ping');
  ee.emit('ping');
  

  Returns a reference to the EventEmitter, so that calls can be chained.

  removeListener(

  eventName: string | symbol,

  listener: (...args: any[]) => void

  ): this;

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

  const callback = (stream) => {
    console.log('someone connected!');
  };
  server.on('connection', callback);
  // ...
  server.removeListener('connection', callback);
  

  removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

  Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

  import { EventEmitter } from 'node:events';
  class MyEmitter extends EventEmitter {}
  const myEmitter = new MyEmitter();
  
  const callbackA = () => {
    console.log('A');
    myEmitter.removeListener('event', callbackB);
  };
  
  const callbackB = () => {
    console.log('B');
  };
  
  myEmitter.on('event', callbackA);
  
  myEmitter.on('event', callbackB);
  
  // callbackA removes listener callbackB but it will still be called.
  // Internal listener array at time of emit [callbackA, callbackB]
  myEmitter.emit('event');
  // Prints:
  //   A
  //   B
  
  // callbackB is now removed.
  // Internal listener array [callbackA]
  myEmitter.emit('event');
  // Prints:
  //   A
  

  Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

  When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

  import { EventEmitter } from 'node:events';
  const ee = new EventEmitter();
  
  function pong() {
    console.log('pong');
  }
  
  ee.on('ping', pong);
  ee.once('ping', pong);
  ee.removeListener('ping', pong);
  
  ee.emit('ping');
  ee.emit('ping');
  

  Returns a reference to the EventEmitter, so that calls can be chained.
• send(

  message: Serializable,

  callback?: (error: null | Error) => 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);
    });
  }
  

  send(

  message: Serializable,

  sendHandle: SendHandle,

  callback?: (error: null | Error) => 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);
    });
  }
  

  send(

  message: Serializable,

  sendHandle: SendHandle,

  options?: MessageOptions,

  callback?: (error: null | Error) => 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);
    });
  }
  

  @param options

  The options argument, if present, is an object used to parameterize the sending of certain types of handles.

• setMaxListeners(

  n: number

  ): this;

  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.

  Returns a reference to the EventEmitter, so that calls can be chained.