@types/node 24.10.2 → 25.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. node/README.md +1 -1
  2. node/assert/strict.d.ts +5 -11
  3. node/assert.d.ts +9 -169
  4. node/async_hooks.d.ts +8 -8
  5. node/buffer.buffer.d.ts +1 -7
  6. node/buffer.d.ts +44 -168
  7. node/child_process.d.ts +16 -64
  8. node/cluster.d.ts +240 -332
  9. node/console.d.ts +49 -351
  10. node/constants.d.ts +3 -4
  11. node/crypto.d.ts +279 -1631
  12. node/dgram.d.ts +15 -51
  13. node/diagnostics_channel.d.ts +4 -4
  14. node/dns/promises.d.ts +3 -3
  15. node/dns.d.ts +131 -132
  16. node/domain.d.ts +13 -17
  17. node/events.d.ts +719 -649
  18. node/fs/promises.d.ts +7 -8
  19. node/fs.d.ts +417 -455
  20. node/globals.d.ts +6 -26
  21. node/globals.typedarray.d.ts +60 -0
  22. node/http.d.ts +263 -254
  23. node/http2.d.ts +528 -804
  24. node/https.d.ts +59 -239
  25. node/index.d.ts +15 -1
  26. node/inspector/promises.d.ts +41 -0
  27. node/inspector.d.ts +6 -59
  28. node/inspector.generated.d.ts +3 -10
  29. node/module.d.ts +47 -122
  30. node/net.d.ts +63 -184
  31. node/os.d.ts +6 -6
  32. node/package.json +2 -2
  33. node/path/posix.d.ts +8 -0
  34. node/path/win32.d.ts +8 -0
  35. node/path.d.ts +120 -133
  36. node/perf_hooks.d.ts +282 -643
  37. node/process.d.ts +151 -128
  38. node/punycode.d.ts +5 -5
  39. node/querystring.d.ts +4 -4
  40. node/quic.d.ts +910 -0
  41. node/readline/promises.d.ts +3 -3
  42. node/readline.d.ts +67 -120
  43. node/repl.d.ts +75 -98
  44. node/sea.d.ts +1 -1
  45. node/sqlite.d.ts +2 -2
  46. node/stream/consumers.d.ts +10 -10
  47. node/stream/promises.d.ts +136 -15
  48. node/stream/web.d.ts +176 -453
  49. node/stream.d.ts +555 -478
  50. node/string_decoder.d.ts +4 -4
  51. node/test/reporters.d.ts +96 -0
  52. node/test.d.ts +80 -180
  53. node/timers/promises.d.ts +4 -4
  54. node/timers.d.ts +4 -130
  55. node/tls.d.ts +102 -177
  56. node/trace_events.d.ts +9 -9
  57. node/ts5.6/buffer.buffer.d.ts +1 -7
  58. node/ts5.6/index.d.ts +15 -1
  59. node/ts5.7/index.d.ts +15 -1
  60. node/tty.d.ts +58 -16
  61. node/url.d.ts +54 -592
  62. node/util/types.d.ts +558 -0
  63. node/util.d.ts +117 -792
  64. node/v8.d.ts +32 -5
  65. node/vm.d.ts +13 -13
  66. node/wasi.d.ts +4 -4
  67. node/web-globals/abortcontroller.d.ts +27 -2
  68. node/web-globals/blob.d.ts +23 -0
  69. node/web-globals/console.d.ts +9 -0
  70. node/web-globals/crypto.d.ts +7 -0
  71. node/web-globals/encoding.d.ts +11 -0
  72. node/web-globals/events.d.ts +9 -0
  73. node/web-globals/fetch.d.ts +4 -0
  74. node/web-globals/importmeta.d.ts +13 -0
  75. node/web-globals/messaging.d.ts +23 -0
  76. node/web-globals/performance.d.ts +45 -0
  77. node/web-globals/streams.d.ts +93 -0
  78. node/web-globals/timers.d.ts +44 -0
  79. node/web-globals/url.d.ts +24 -0
  80. node/worker_threads.d.ts +176 -358
  81. node/zlib.d.ts +8 -71
node/cluster.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Clusters of Node.js processes can be used to run multiple instances of Node.js
3
3
  * that can distribute workloads among their application threads. When process isolation
4
- * is not needed, use the [`worker_threads`](https://nodejs.org/docs/latest-v24.x/api/worker_threads.html)
4
+ * is not needed, use the [`worker_threads`](https://nodejs.org/docs/latest-v25.x/api/worker_threads.html)
5
5
  * module instead, which allows running multiple application threads within a single Node.js instance.
6
6
  *
7
7
  * The cluster module allows easy creation of child processes that all share
@@ -50,90 +50,13 @@
50
50
  * ```
51
51
  *
52
52
  * On Windows, it is not yet possible to set up a named pipe server in a worker.
53
- * @see [source](https://github.com/nodejs/node/blob/v24.x/lib/cluster.js)
53
+ * @see [source](https://github.com/nodejs/node/blob/v25.x/lib/cluster.js)
54
54
  */
55
- declare module "cluster" {
56
- import * as child from "node:child_process";
57
- import EventEmitter = require("node:events");
58
- import * as net from "node:net";
59
- type SerializationType = "json" | "advanced";
60
- export interface ClusterSettings {
61
- /**
62
- * List of string arguments passed to the Node.js executable.
63
- * @default process.execArgv
64
- */
65
- execArgv?: string[] | undefined;
66
- /**
67
- * File path to worker file.
68
- * @default process.argv[1]
69
- */
70
- exec?: string | undefined;
71
- /**
72
- * String arguments passed to worker.
73
- * @default process.argv.slice(2)
74
- */
75
- args?: readonly string[] | undefined;
76
- /**
77
- * Whether or not to send output to parent's stdio.
78
- * @default false
79
- */
80
- silent?: boolean | undefined;
81
- /**
82
- * Configures the stdio of forked processes. Because the cluster module relies on IPC to function, this configuration must
83
- * contain an `'ipc'` entry. When this option is provided, it overrides `silent`. See [`child_prcess.spawn()`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#child_processspawncommand-args-options)'s
84
- * [`stdio`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#optionsstdio).
85
- */
86
- stdio?: any[] | undefined;
87
- /**
88
- * Sets the user identity of the process. (See [`setuid(2)`](https://man7.org/linux/man-pages/man2/setuid.2.html).)
89
- */
90
- uid?: number | undefined;
91
- /**
92
- * Sets the group identity of the process. (See [`setgid(2)`](https://man7.org/linux/man-pages/man2/setgid.2.html).)
93
- */
94
- gid?: number | undefined;
95
- /**
96
- * Sets inspector port of worker. This can be a number, or a function that takes no arguments and returns a number.
97
- * By default each worker gets its own port, incremented from the primary's `process.debugPort`.
98
- */
99
- inspectPort?: number | (() => number) | undefined;
100
- /**
101
- * Specify the kind of serialization used for sending messages between processes. Possible values are `'json'` and `'advanced'`.
102
- * See [Advanced serialization for `child_process`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#advanced-serialization) for more details.
103
- * @default false
104
- */
105
- serialization?: SerializationType | undefined;
106
- /**
107
- * Current working directory of the worker process.
108
- * @default undefined (inherits from parent process)
109
- */
110
- cwd?: string | undefined;
111
- /**
112
- * Hide the forked processes console window that would normally be created on Windows systems.
113
- * @default false
114
- */
115
- windowsHide?: boolean | undefined;
116
- }
117
- export interface Address {
118
- address: string;
119
- port: number;
120
- /**
121
- * The `addressType` is one of:
122
- *
123
- * * `4` (TCPv4)
124
- * * `6` (TCPv6)
125
- * * `-1` (Unix domain socket)
126
- * * `'udp4'` or `'udp6'` (UDPv4 or UDPv6)
127
- */
128
- addressType: 4 | 6 | -1 | "udp4" | "udp6";
129
- }
130
- /**
131
- * A `Worker` object contains all public information and method about a worker.
132
- * In the primary it can be obtained using `cluster.workers`. In a worker
133
- * it can be obtained using `cluster.worker`.
134
- * @since v0.7.0
135
- */
136
- export class Worker extends EventEmitter {
55
+ declare module "node:cluster" {
56
+ import * as child_process from "node:child_process";
57
+ import { EventEmitter, InternalEventEmitter } from "node:events";
58
+ class Worker implements EventEmitter {
59
+ constructor(options?: cluster.WorkerOptions);
137
60
  /**
138
61
  * Each new worker is given its own unique id, this id is stored in the `id`.
139
62
  *
@@ -142,21 +65,21 @@ declare module "cluster" {
142
65
  */
143
66
  id: number;
144
67
  /**
145
- * All workers are created using [`child_process.fork()`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#child_processforkmodulepath-args-options), the returned object
68
+ * All workers are created using [`child_process.fork()`](https://nodejs.org/docs/latest-v25.x/api/child_process.html#child_processforkmodulepath-args-options), the returned object
146
69
  * from this function is stored as `.process`. In a worker, the global `process` is stored.
147
70
  *
148
- * See: [Child Process module](https://nodejs.org/docs/latest-v24.x/api/child_process.html#child_processforkmodulepath-args-options).
71
+ * See: [Child Process module](https://nodejs.org/docs/latest-v25.x/api/child_process.html#child_processforkmodulepath-args-options).
149
72
  *
150
73
  * Workers will call `process.exit(0)` if the `'disconnect'` event occurs
151
74
  * on `process` and `.exitedAfterDisconnect` is not `true`. This protects against
152
75
  * accidental disconnection.
153
76
  * @since v0.7.0
154
77
  */
155
- process: child.ChildProcess;
78
+ process: child_process.ChildProcess;
156
79
  /**
157
80
  * Send a message to a worker or primary, optionally with a handle.
158
81
  *
159
- * In the primary, this sends a message to a specific worker. It is identical to [`ChildProcess.send()`](https://nodejs.org/docs/latest-v24.x/api/child_process.html#subprocesssendmessage-sendhandle-options-callback).
82
+ * In the primary, this sends a message to a specific worker. It is identical to [`ChildProcess.send()`](https://nodejs.org/docs/latest-v25.x/api/child_process.html#subprocesssendmessage-sendhandle-options-callback).
160
83
  *
161
84
  * In a worker, this sends a message to the primary. It is identical to `process.send()`.
162
85
  *
@@ -176,16 +99,16 @@ declare module "cluster" {
176
99
  * @since v0.7.0
177
100
  * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles.
178
101
  */
179
- send(message: child.Serializable, callback?: (error: Error | null) => void): boolean;
102
+ send(message: child_process.Serializable, callback?: (error: Error | null) => void): boolean;
180
103
  send(
181
- message: child.Serializable,
182
- sendHandle: child.SendHandle,
104
+ message: child_process.Serializable,
105
+ sendHandle: child_process.SendHandle,
183
106
  callback?: (error: Error | null) => void,
184
107
  ): boolean;
185
108
  send(
186
- message: child.Serializable,
187
- sendHandle: child.SendHandle,
188
- options?: child.MessageOptions,
109
+ message: child_process.Serializable,
110
+ sendHandle: child_process.SendHandle,
111
+ options?: child_process.MessageOptions,
189
112
  callback?: (error: Error | null) => void,
190
113
  ): boolean;
191
114
  /**
@@ -198,7 +121,7 @@ declare module "cluster" {
198
121
  * This method is aliased as `worker.destroy()` for backwards compatibility.
199
122
  *
200
123
  * In a worker, `process.kill()` exists, but it is not this function;
201
- * it is [`kill()`](https://nodejs.org/docs/latest-v24.x/api/process.html#processkillpid-signal).
124
+ * it is [`kill()`](https://nodejs.org/docs/latest-v25.x/api/process.html#processkillpid-signal).
202
125
  * @since v0.9.12
203
126
  * @param [signal='SIGTERM'] Name of the kill signal to send to the worker process.
204
127
  */
@@ -335,244 +258,229 @@ declare module "cluster" {
335
258
  * @since v6.0.0
336
259
  */
337
260
  exitedAfterDisconnect: boolean;
338
- /**
339
- * events.EventEmitter
340
- * 1. disconnect
341
- * 2. error
342
- * 3. exit
343
- * 4. listening
344
- * 5. message
345
- * 6. online
346
- */
347
- addListener(event: string, listener: (...args: any[]) => void): this;
348
- addListener(event: "disconnect", listener: () => void): this;
349
- addListener(event: "error", listener: (error: Error) => void): this;
350
- addListener(event: "exit", listener: (code: number, signal: string) => void): this;
351
- addListener(event: "listening", listener: (address: Address) => void): this;
352
- addListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
353
- addListener(event: "online", listener: () => void): this;
354
- emit(event: string | symbol, ...args: any[]): boolean;
355
- emit(event: "disconnect"): boolean;
356
- emit(event: "error", error: Error): boolean;
357
- emit(event: "exit", code: number, signal: string): boolean;
358
- emit(event: "listening", address: Address): boolean;
359
- emit(event: "message", message: any, handle: net.Socket | net.Server): boolean;
360
- emit(event: "online"): boolean;
361
- on(event: string, listener: (...args: any[]) => void): this;
362
- on(event: "disconnect", listener: () => void): this;
363
- on(event: "error", listener: (error: Error) => void): this;
364
- on(event: "exit", listener: (code: number, signal: string) => void): this;
365
- on(event: "listening", listener: (address: Address) => void): this;
366
- on(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
367
- on(event: "online", listener: () => void): this;
368
- once(event: string, listener: (...args: any[]) => void): this;
369
- once(event: "disconnect", listener: () => void): this;
370
- once(event: "error", listener: (error: Error) => void): this;
371
- once(event: "exit", listener: (code: number, signal: string) => void): this;
372
- once(event: "listening", listener: (address: Address) => void): this;
373
- once(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
374
- once(event: "online", listener: () => void): this;
375
- prependListener(event: string, listener: (...args: any[]) => void): this;
376
- prependListener(event: "disconnect", listener: () => void): this;
377
- prependListener(event: "error", listener: (error: Error) => void): this;
378
- prependListener(event: "exit", listener: (code: number, signal: string) => void): this;
379
- prependListener(event: "listening", listener: (address: Address) => void): this;
380
- prependListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
381
- prependListener(event: "online", listener: () => void): this;
382
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
383
- prependOnceListener(event: "disconnect", listener: () => void): this;
384
- prependOnceListener(event: "error", listener: (error: Error) => void): this;
385
- prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this;
386
- prependOnceListener(event: "listening", listener: (address: Address) => void): this;
387
- prependOnceListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
388
- prependOnceListener(event: "online", listener: () => void): this;
389
261
  }
390
- export interface Cluster extends EventEmitter {
391
- disconnect(callback?: () => void): void;
392
- /**
393
- * Spawn a new worker process.
394
- *
395
- * This can only be called from the primary process.
396
- * @param env Key/value pairs to add to worker process environment.
397
- * @since v0.6.0
398
- */
399
- fork(env?: any): Worker;
400
- /** @deprecated since v16.0.0 - use isPrimary. */
401
- readonly isMaster: boolean;
402
- /**
403
- * True if the process is a primary. This is determined by the `process.env.NODE_UNIQUE_ID`. If `process.env.NODE_UNIQUE_ID`
404
- * is undefined, then `isPrimary` is `true`.
405
- * @since v16.0.0
406
- */
407
- readonly isPrimary: boolean;
408
- /**
409
- * True if the process is not a primary (it is the negation of `cluster.isPrimary`).
410
- * @since v0.6.0
411
- */
412
- readonly isWorker: boolean;
413
- /**
414
- * The scheduling policy, either `cluster.SCHED_RR` for round-robin or `cluster.SCHED_NONE` to leave it to the operating system. This is a
415
- * global setting and effectively frozen once either the first worker is spawned, or [`.setupPrimary()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clustersetupprimarysettings)
416
- * is called, whichever comes first.
417
- *
418
- * `SCHED_RR` is the default on all operating systems except Windows. Windows will change to `SCHED_RR` once libuv is able to effectively distribute
419
- * IOCP handles without incurring a large performance hit.
420
- *
421
- * `cluster.schedulingPolicy` can also be set through the `NODE_CLUSTER_SCHED_POLICY` environment variable. Valid values are `'rr'` and `'none'`.
422
- * @since v0.11.2
423
- */
424
- schedulingPolicy: number;
425
- /**
426
- * After calling [`.setupPrimary()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clustersetupprimarysettings)
427
- * (or [`.fork()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clusterforkenv)) this settings object will contain
428
- * the settings, including the default values.
429
- *
430
- * This object is not intended to be changed or set manually.
431
- * @since v0.7.1
432
- */
433
- readonly settings: ClusterSettings;
434
- /** @deprecated since v16.0.0 - use [`.setupPrimary()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clustersetupprimarysettings) instead. */
435
- setupMaster(settings?: ClusterSettings): void;
436
- /**
437
- * `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in `cluster.settings`.
438
- *
439
- * Any settings changes only affect future calls to [`.fork()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clusterforkenv)
440
- * and have no effect on workers that are already running.
441
- *
442
- * The only attribute of a worker that cannot be set via `.setupPrimary()` is the `env` passed to
443
- * [`.fork()`](https://nodejs.org/docs/latest-v24.x/api/cluster.html#clusterforkenv).
444
- *
445
- * The defaults above apply to the first call only; the defaults for later calls are the current values at the time of
446
- * `cluster.setupPrimary()` is called.
447
- *
448
- * ```js
449
- * import cluster from 'node:cluster';
450
- *
451
- * cluster.setupPrimary({
452
- * exec: 'worker.js',
453
- * args: ['--use', 'https'],
454
- * silent: true,
455
- * });
456
- * cluster.fork(); // https worker
457
- * cluster.setupPrimary({
458
- * exec: 'worker.js',
459
- * args: ['--use', 'http'],
460
- * });
461
- * cluster.fork(); // http worker
462
- * ```
463
- *
464
- * This can only be called from the primary process.
465
- * @since v16.0.0
466
- */
467
- setupPrimary(settings?: ClusterSettings): void;
468
- /**
469
- * A reference to the current worker object. Not available in the primary process.
470
- *
471
- * ```js
472
- * import cluster from 'node:cluster';
473
- *
474
- * if (cluster.isPrimary) {
475
- * console.log('I am primary');
476
- * cluster.fork();
477
- * cluster.fork();
478
- * } else if (cluster.isWorker) {
479
- * console.log(`I am worker #${cluster.worker.id}`);
480
- * }
481
- * ```
482
- * @since v0.7.0
483
- */
484
- readonly worker?: Worker;
485
- /**
486
- * A hash that stores the active worker objects, keyed by `id` field. This makes it easy to loop through all the workers. It is only available in the primary process.
487
- *
488
- * A worker is removed from `cluster.workers` after the worker has disconnected _and_ exited. The order between these two events cannot be determined in advance. However, it
489
- * is guaranteed that the removal from the `cluster.workers` list happens before the last `'disconnect'` or `'exit'` event is emitted.
490
- *
491
- * ```js
492
- * import cluster from 'node:cluster';
493
- *
494
- * for (const worker of Object.values(cluster.workers)) {
495
- * worker.send('big announcement to all workers');
496
- * }
497
- * ```
498
- * @since v0.7.0
499
- */
500
- readonly workers?: NodeJS.Dict<Worker>;
501
- readonly SCHED_NONE: number;
502
- readonly SCHED_RR: number;
503
- /**
504
- * events.EventEmitter
505
- * 1. disconnect
506
- * 2. exit
507
- * 3. fork
508
- * 4. listening
509
- * 5. message
510
- * 6. online
511
- * 7. setup
512
- */
513
- addListener(event: string, listener: (...args: any[]) => void): this;
514
- addListener(event: "disconnect", listener: (worker: Worker) => void): this;
515
- addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
516
- addListener(event: "fork", listener: (worker: Worker) => void): this;
517
- addListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
518
- addListener(
519
- event: "message",
520
- listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void,
521
- ): this; // the handle is a net.Socket or net.Server object, or undefined.
522
- addListener(event: "online", listener: (worker: Worker) => void): this;
523
- addListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
524
- emit(event: string | symbol, ...args: any[]): boolean;
525
- emit(event: "disconnect", worker: Worker): boolean;
526
- emit(event: "exit", worker: Worker, code: number, signal: string): boolean;
527
- emit(event: "fork", worker: Worker): boolean;
528
- emit(event: "listening", worker: Worker, address: Address): boolean;
529
- emit(event: "message", worker: Worker, message: any, handle: net.Socket | net.Server): boolean;
530
- emit(event: "online", worker: Worker): boolean;
531
- emit(event: "setup", settings: ClusterSettings): boolean;
532
- on(event: string, listener: (...args: any[]) => void): this;
533
- on(event: "disconnect", listener: (worker: Worker) => void): this;
534
- on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
535
- on(event: "fork", listener: (worker: Worker) => void): this;
536
- on(event: "listening", listener: (worker: Worker, address: Address) => void): this;
537
- on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
538
- on(event: "online", listener: (worker: Worker) => void): this;
539
- on(event: "setup", listener: (settings: ClusterSettings) => void): this;
540
- once(event: string, listener: (...args: any[]) => void): this;
541
- once(event: "disconnect", listener: (worker: Worker) => void): this;
542
- once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
543
- once(event: "fork", listener: (worker: Worker) => void): this;
544
- once(event: "listening", listener: (worker: Worker, address: Address) => void): this;
545
- once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
546
- once(event: "online", listener: (worker: Worker) => void): this;
547
- once(event: "setup", listener: (settings: ClusterSettings) => void): this;
548
- prependListener(event: string, listener: (...args: any[]) => void): this;
549
- prependListener(event: "disconnect", listener: (worker: Worker) => void): this;
550
- prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
551
- prependListener(event: "fork", listener: (worker: Worker) => void): this;
552
- prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
553
- prependListener(
554
- event: "message",
555
- listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void,
556
- ): this;
557
- prependListener(event: "online", listener: (worker: Worker) => void): this;
558
- prependListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
559
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
560
- prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): this;
561
- prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
562
- prependOnceListener(event: "fork", listener: (worker: Worker) => void): this;
563
- prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
564
- // the handle is a net.Socket or net.Server object, or undefined.
565
- prependOnceListener(
566
- event: "message",
567
- listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void,
568
- ): this;
569
- prependOnceListener(event: "online", listener: (worker: Worker) => void): this;
570
- prependOnceListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
262
+ interface Worker extends InternalEventEmitter<cluster.WorkerEventMap> {}
263
+ type _Worker = Worker;
264
+ namespace cluster {
265
+ interface Worker extends _Worker {}
266
+ interface WorkerOptions {
267
+ id?: number | undefined;
268
+ process?: child_process.ChildProcess | undefined;
269
+ state?: string | undefined;
270
+ }
271
+ interface WorkerEventMap {
272
+ "disconnect": [];
273
+ "error": [error: Error];
274
+ "exit": [code: number, signal: string];
275
+ "listening": [address: Address];
276
+ "message": [message: any, handle: child_process.SendHandle];
277
+ "online": [];
278
+ }
279
+ interface ClusterSettings {
280
+ /**
281
+ * List of string arguments passed to the Node.js executable.
282
+ * @default process.execArgv
283
+ */
284
+ execArgv?: string[] | undefined;
285
+ /**
286
+ * File path to worker file.
287
+ * @default process.argv[1]
288
+ */
289
+ exec?: string | undefined;
290
+ /**
291
+ * String arguments passed to worker.
292
+ * @default process.argv.slice(2)
293
+ */
294
+ args?: readonly string[] | undefined;
295
+ /**
296
+ * Whether or not to send output to parent's stdio.
297
+ * @default false
298
+ */
299
+ silent?: boolean | undefined;
300
+ /**
301
+ * Configures the stdio of forked processes. Because the cluster module relies on IPC to function, this configuration must
302
+ * contain an `'ipc'` entry. When this option is provided, it overrides `silent`. See [`child_prcess.spawn()`](https://nodejs.org/docs/latest-v25.x/api/child_process.html#child_processspawncommand-args-options)'s
303
+ * [`stdio`](https://nodejs.org/docs/latest-v25.x/api/child_process.html#optionsstdio).
304
+ */
305
+ stdio?: any[] | undefined;
306
+ /**
307
+ * Sets the user identity of the process. (See [`setuid(2)`](https://man7.org/linux/man-pages/man2/setuid.2.html).)
308
+ */
309
+ uid?: number | undefined;
310
+ /**
311
+ * Sets the group identity of the process. (See [`setgid(2)`](https://man7.org/linux/man-pages/man2/setgid.2.html).)
312
+ */
313
+ gid?: number | undefined;
314
+ /**
315
+ * Sets inspector port of worker. This can be a number, or a function that takes no arguments and returns a number.
316
+ * By default each worker gets its own port, incremented from the primary's `process.debugPort`.
317
+ */
318
+ inspectPort?: number | (() => number) | undefined;
319
+ /**
320
+ * Specify the kind of serialization used for sending messages between processes. Possible values are `'json'` and `'advanced'`.
321
+ * See [Advanced serialization for `child_process`](https://nodejs.org/docs/latest-v25.x/api/child_process.html#advanced-serialization) for more details.
322
+ * @default false
323
+ */
324
+ serialization?: "json" | "advanced" | undefined;
325
+ /**
326
+ * Current working directory of the worker process.
327
+ * @default undefined (inherits from parent process)
328
+ */
329
+ cwd?: string | undefined;
330
+ /**
331
+ * Hide the forked processes console window that would normally be created on Windows systems.
332
+ * @default false
333
+ */
334
+ windowsHide?: boolean | undefined;
335
+ }
336
+ interface Address {
337
+ address: string;
338
+ port: number;
339
+ /**
340
+ * The `addressType` is one of:
341
+ *
342
+ * * `4` (TCPv4)
343
+ * * `6` (TCPv6)
344
+ * * `-1` (Unix domain socket)
345
+ * * `'udp4'` or `'udp6'` (UDPv4 or UDPv6)
346
+ */
347
+ addressType: 4 | 6 | -1 | "udp4" | "udp6";
348
+ }
349
+ interface ClusterEventMap {
350
+ "disconnect": [worker: Worker];
351
+ "exit": [worker: Worker, code: number, signal: string];
352
+ "fork": [worker: Worker];
353
+ "listening": [worker: Worker, address: Address];
354
+ "message": [worker: Worker, message: any, handle: child_process.SendHandle];
355
+ "online": [worker: Worker];
356
+ "setup": [settings: ClusterSettings];
357
+ }
358
+ interface Cluster extends InternalEventEmitter<ClusterEventMap> {
359
+ /**
360
+ * A `Worker` object contains all public information and method about a worker.
361
+ * In the primary it can be obtained using `cluster.workers`. In a worker
362
+ * it can be obtained using `cluster.worker`.
363
+ * @since v0.7.0
364
+ */
365
+ Worker: typeof Worker;
366
+ disconnect(callback?: () => void): void;
367
+ /**
368
+ * Spawn a new worker process.
369
+ *
370
+ * This can only be called from the primary process.
371
+ * @param env Key/value pairs to add to worker process environment.
372
+ * @since v0.6.0
373
+ */
374
+ fork(env?: any): Worker;
375
+ /** @deprecated since v16.0.0 - use isPrimary. */
376
+ readonly isMaster: boolean;
377
+ /**
378
+ * True if the process is a primary. This is determined by the `process.env.NODE_UNIQUE_ID`. If `process.env.NODE_UNIQUE_ID`
379
+ * is undefined, then `isPrimary` is `true`.
380
+ * @since v16.0.0
381
+ */
382
+ readonly isPrimary: boolean;
383
+ /**
384
+ * True if the process is not a primary (it is the negation of `cluster.isPrimary`).
385
+ * @since v0.6.0
386
+ */
387
+ readonly isWorker: boolean;
388
+ /**
389
+ * The scheduling policy, either `cluster.SCHED_RR` for round-robin or `cluster.SCHED_NONE` to leave it to the operating system. This is a
390
+ * global setting and effectively frozen once either the first worker is spawned, or [`.setupPrimary()`](https://nodejs.org/docs/latest-v25.x/api/cluster.html#clustersetupprimarysettings)
391
+ * is called, whichever comes first.
392
+ *
393
+ * `SCHED_RR` is the default on all operating systems except Windows. Windows will change to `SCHED_RR` once libuv is able to effectively distribute
394
+ * IOCP handles without incurring a large performance hit.
395
+ *
396
+ * `cluster.schedulingPolicy` can also be set through the `NODE_CLUSTER_SCHED_POLICY` environment variable. Valid values are `'rr'` and `'none'`.
397
+ * @since v0.11.2
398
+ */
399
+ schedulingPolicy: number;
400
+ /**
401
+ * After calling [`.setupPrimary()`](https://nodejs.org/docs/latest-v25.x/api/cluster.html#clustersetupprimarysettings)
402
+ * (or [`.fork()`](https://nodejs.org/docs/latest-v25.x/api/cluster.html#clusterforkenv)) this settings object will contain
403
+ * the settings, including the default values.
404
+ *
405
+ * This object is not intended to be changed or set manually.
406
+ * @since v0.7.1
407
+ */
408
+ readonly settings: ClusterSettings;
409
+ /** @deprecated since v16.0.0 - use [`.setupPrimary()`](https://nodejs.org/docs/latest-v25.x/api/cluster.html#clustersetupprimarysettings) instead. */
410
+ setupMaster(settings?: ClusterSettings): void;
411
+ /**
412
+ * `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in `cluster.settings`.
413
+ *
414
+ * Any settings changes only affect future calls to [`.fork()`](https://nodejs.org/docs/latest-v25.x/api/cluster.html#clusterforkenv)
415
+ * and have no effect on workers that are already running.
416
+ *
417
+ * The only attribute of a worker that cannot be set via `.setupPrimary()` is the `env` passed to
418
+ * [`.fork()`](https://nodejs.org/docs/latest-v25.x/api/cluster.html#clusterforkenv).
419
+ *
420
+ * The defaults above apply to the first call only; the defaults for later calls are the current values at the time of
421
+ * `cluster.setupPrimary()` is called.
422
+ *
423
+ * ```js
424
+ * import cluster from 'node:cluster';
425
+ *
426
+ * cluster.setupPrimary({
427
+ * exec: 'worker.js',
428
+ * args: ['--use', 'https'],
429
+ * silent: true,
430
+ * });
431
+ * cluster.fork(); // https worker
432
+ * cluster.setupPrimary({
433
+ * exec: 'worker.js',
434
+ * args: ['--use', 'http'],
435
+ * });
436
+ * cluster.fork(); // http worker
437
+ * ```
438
+ *
439
+ * This can only be called from the primary process.
440
+ * @since v16.0.0
441
+ */
442
+ setupPrimary(settings?: ClusterSettings): void;
443
+ /**
444
+ * A reference to the current worker object. Not available in the primary process.
445
+ *
446
+ * ```js
447
+ * import cluster from 'node:cluster';
448
+ *
449
+ * if (cluster.isPrimary) {
450
+ * console.log('I am primary');
451
+ * cluster.fork();
452
+ * cluster.fork();
453
+ * } else if (cluster.isWorker) {
454
+ * console.log(`I am worker #${cluster.worker.id}`);
455
+ * }
456
+ * ```
457
+ * @since v0.7.0
458
+ */
459
+ readonly worker?: Worker;
460
+ /**
461
+ * A hash that stores the active worker objects, keyed by `id` field. This makes it easy to loop through all the workers. It is only available in the primary process.
462
+ *
463
+ * A worker is removed from `cluster.workers` after the worker has disconnected _and_ exited. The order between these two events cannot be determined in advance. However, it
464
+ * is guaranteed that the removal from the `cluster.workers` list happens before the last `'disconnect'` or `'exit'` event is emitted.
465
+ *
466
+ * ```js
467
+ * import cluster from 'node:cluster';
468
+ *
469
+ * for (const worker of Object.values(cluster.workers)) {
470
+ * worker.send('big announcement to all workers');
471
+ * }
472
+ * ```
473
+ * @since v0.7.0
474
+ */
475
+ readonly workers?: NodeJS.Dict<Worker>;
476
+ readonly SCHED_NONE: number;
477
+ readonly SCHED_RR: number;
478
+ }
571
479
  }
572
- const cluster: Cluster;
573
- export default cluster;
480
+ var cluster: cluster.Cluster;
481
+ export = cluster;
574
482
  }
575
- declare module "node:cluster" {
576
- export * from "cluster";
577
- export { default as default } from "cluster";
483
+ declare module "cluster" {
484
+ import cluster = require("node:cluster");
485
+ export = cluster;
578
486
  }