@@ -195,14 +195,14 @@ changes:
195
195
` '/bin/sh' ` on Unix, ` process.env.ComSpec ` on Windows.
196
196
* ` signal ` {AbortSignal} allows aborting the child process using an
197
197
AbortSignal.
198
- * ` timeout ` {number } ** Default:** ` 0 `
199
- * ` maxBuffer ` {number } Largest amount of data in bytes allowed on stdout or
198
+ * ` timeout ` {integer } ** Default:** ` 0 `
199
+ * ` maxBuffer ` {integer } Largest amount of data in bytes allowed on stdout or
200
200
stderr. If exceeded, the child process is terminated and any output is
201
201
truncated. See caveat at [ ` maxBuffer ` and Unicode] [ ] .
202
202
** Default:** ` 1024 * 1024 ` .
203
203
* ` killSignal ` {string|integer} ** Default:** ` 'SIGTERM' `
204
- * ` uid ` {number } Sets the user identity of the process (see setuid(2)).
205
- * ` gid ` {number } Sets the group identity of the process (see setgid(2)).
204
+ * ` uid ` {integer } Sets the user identity of the process (see setuid(2)).
205
+ * ` gid ` {integer } Sets the group identity of the process (see setgid(2)).
206
206
* ` windowsHide ` {boolean} Hide the subprocess console window that would
207
207
normally be created on Windows systems. ** Default:** ` false ` .
208
208
* ` callback ` {Function} called with the output when process terminates.
@@ -375,14 +375,14 @@ changes:
375
375
* ` cwd ` {string|URL} Current working directory of the child process.
376
376
* ` env ` {Object} Environment key-value pairs. ** Default:** ` process.env ` .
377
377
* ` encoding ` {string} ** Default:** ` 'utf8' `
378
- * ` timeout ` {number } ** Default:** ` 0 `
379
- * ` maxBuffer ` {number } Largest amount of data in bytes allowed on stdout or
378
+ * ` timeout ` {integer } ** Default:** ` 0 `
379
+ * ` maxBuffer ` {integer } Largest amount of data in bytes allowed on stdout or
380
380
stderr. If exceeded, the child process is terminated and any output is
381
381
truncated. See caveat at [ ` maxBuffer ` and Unicode] [ ] .
382
382
** Default:** ` 1024 * 1024 ` .
383
383
* ` killSignal ` {string|integer} ** Default:** ` 'SIGTERM' `
384
- * ` uid ` {number } Sets the user identity of the process (see setuid(2)).
385
- * ` gid ` {number } Sets the group identity of the process (see setgid(2)).
384
+ * ` uid ` {integer } Sets the user identity of the process (see setuid(2)).
385
+ * ` gid ` {integer } Sets the group identity of the process (see setgid(2)).
386
386
* ` windowsHide ` {boolean} Hide the subprocess console window that would
387
387
normally be created on Windows systems. ** Default:** ` false ` .
388
388
* ` windowsVerbatimArguments ` {boolean} No quoting or escaping of arguments is
@@ -547,7 +547,7 @@ changes:
547
547
* ` execPath ` {string} Executable used to create the child process.
548
548
* ` execArgv ` {string\[ ] } List of string arguments passed to the executable.
549
549
** Default:** ` process.execArgv ` .
550
- * ` gid ` {number } Sets the group identity of the process (see setgid(2)).
550
+ * ` gid ` {integer } Sets the group identity of the process (see setgid(2)).
551
551
* ` serialization ` {string} Specify the kind of serialization used for sending
552
552
messages between processes. Possible values are ` 'json' ` and ` 'advanced' ` .
553
553
See [ Advanced serialization] [ ] for more details. ** Default:** ` 'json' ` .
@@ -564,10 +564,10 @@ changes:
564
564
When this option is provided, it overrides ` silent ` . If the array variant
565
565
is used, it must contain exactly one item with value ` 'ipc' ` or an error
566
566
will be thrown. For instance ` [0, 1, 2, 'ipc'] ` .
567
- * ` uid ` {number } Sets the user identity of the process (see setuid(2)).
567
+ * ` uid ` {integer } Sets the user identity of the process (see setuid(2)).
568
568
* ` windowsVerbatimArguments ` {boolean} No quoting or escaping of arguments is
569
569
done on Windows. Ignored on Unix. ** Default:** ` false ` .
570
- * ` timeout ` {number } In milliseconds the maximum amount of time the process
570
+ * ` timeout ` {integer } In milliseconds the maximum amount of time the process
571
571
is allowed to run. ** Default:** ` undefined ` .
572
572
* Returns: {ChildProcess}
573
573
@@ -700,8 +700,8 @@ changes:
700
700
* ` detached` {boolean} Prepare child process to run independently of
701
701
its parent process. Specific behavior depends on the platform (see
702
702
[` options .detached ` ][]).
703
- * ` uid` {number } Sets the user identity of the process (see setuid(2)).
704
- * ` gid` {number } Sets the group identity of the process (see setgid(2)).
703
+ * ` uid` {integer } Sets the user identity of the process (see setuid(2)).
704
+ * ` gid` {integer } Sets the group identity of the process (see setgid(2)).
705
705
* ` serialization` {string} Specify the kind of serialization used for sending
706
706
messages between processes. Possible values are ` ' json' ` and ` ' advanced' ` .
707
707
See [Advanced serialization][] for more details. **Default:** ` ' json' ` .
@@ -716,7 +716,7 @@ changes:
716
716
normally be created on Windows systems. **Default:** ` false ` .
717
717
* ` signal` {AbortSignal} allows aborting the child process using an
718
718
AbortSignal.
719
- * ` timeout` {number } In milliseconds the maximum amount of time the process
719
+ * ` timeout` {integer } In milliseconds the maximum amount of time the process
720
720
is allowed to run. **Default:** ` undefined ` .
721
721
* ` killSignal` {string|integer} The signal value to be used when the spawned
722
722
process will be killed by timeout or abort signal. **Default:** ` ' SIGTERM' ` .
@@ -1179,13 +1179,13 @@ changes:
1179
1179
be output to the parent process' stderr unless ` stdio` is specified.
1180
1180
**Default:** ` ' pipe' ` .
1181
1181
* ` env` {Object} Environment key-value pairs. **Default:** ` process .env ` .
1182
- * ` uid` {number } Sets the user identity of the process (see setuid(2)).
1183
- * ` gid` {number } Sets the group identity of the process (see setgid(2)).
1184
- * ` timeout` {number } In milliseconds the maximum amount of time the process
1182
+ * ` uid` {integer } Sets the user identity of the process (see setuid(2)).
1183
+ * ` gid` {integer } Sets the group identity of the process (see setgid(2)).
1184
+ * ` timeout` {integer } In milliseconds the maximum amount of time the process
1185
1185
is allowed to run. **Default:** ` undefined ` .
1186
1186
* ` killSignal` {string|integer} The signal value to be used when the spawned
1187
1187
process will be killed. **Default:** ` ' SIGTERM' ` .
1188
- * ` maxBuffer` {number } Largest amount of data in bytes allowed on stdout or
1188
+ * ` maxBuffer` {integer } Largest amount of data in bytes allowed on stdout or
1189
1189
stderr. If exceeded, the child process is terminated. See caveat at
1190
1190
[` maxBuffer` and Unicode][]. **Default:** ` 1024 * 1024 ` .
1191
1191
* ` encoding` {string} The encoding used for all stdio inputs and outputs.
@@ -1309,13 +1309,13 @@ changes:
1309
1309
* ` shell` {string} Shell to execute the command with. See
1310
1310
[Shell requirements][] and [Default Windows shell][]. **Default:**
1311
1311
` ' /bin/sh' ` on Unix, ` process .env .ComSpec ` on Windows.
1312
- * ` uid` {number } Sets the user identity of the process. (See setuid(2)).
1313
- * ` gid` {number } Sets the group identity of the process. (See setgid(2)).
1314
- * ` timeout` {number } In milliseconds the maximum amount of time the process
1312
+ * ` uid` {integer } Sets the user identity of the process. (See setuid(2)).
1313
+ * ` gid` {integer } Sets the group identity of the process. (See setgid(2)).
1314
+ * ` timeout` {integer } In milliseconds the maximum amount of time the process
1315
1315
is allowed to run. **Default:** ` undefined ` .
1316
1316
* ` killSignal` {string|integer} The signal value to be used when the spawned
1317
1317
process will be killed. **Default:** ` ' SIGTERM' ` .
1318
- * ` maxBuffer` {number } Largest amount of data in bytes allowed on stdout or
1318
+ * ` maxBuffer` {integer } Largest amount of data in bytes allowed on stdout or
1319
1319
stderr. If exceeded, the child process is terminated and any output is
1320
1320
truncated. See caveat at [` maxBuffer` and Unicode][].
1321
1321
**Default:** ` 1024 * 1024 ` .
@@ -1383,13 +1383,13 @@ changes:
1383
1383
* ` stdio` {string|Array} Child's stdio configuration.
1384
1384
See [` child_process .spawn ()` ][]'s [` stdio` ][]. **Default:** ` ' pipe' ` .
1385
1385
* ` env` {Object} Environment key-value pairs. **Default:** ` process .env ` .
1386
- * ` uid` {number } Sets the user identity of the process (see setuid(2)).
1387
- * ` gid` {number } Sets the group identity of the process (see setgid(2)).
1388
- * ` timeout` {number } In milliseconds the maximum amount of time the process
1386
+ * ` uid` {integer } Sets the user identity of the process (see setuid(2)).
1387
+ * ` gid` {integer } Sets the group identity of the process (see setgid(2)).
1388
+ * ` timeout` {integer } In milliseconds the maximum amount of time the process
1389
1389
is allowed to run. **Default:** ` undefined ` .
1390
1390
* ` killSignal` {string|integer} The signal value to be used when the spawned
1391
1391
process will be killed. **Default:** ` ' SIGTERM' ` .
1392
- * ` maxBuffer` {number } Largest amount of data in bytes allowed on stdout or
1392
+ * ` maxBuffer` {integer } Largest amount of data in bytes allowed on stdout or
1393
1393
stderr. If exceeded, the child process is terminated and any output is
1394
1394
truncated. See caveat at [` maxBuffer` and Unicode][].
1395
1395
**Default:** ` 1024 * 1024 ` .
@@ -1405,11 +1405,11 @@ changes:
1405
1405
* ` windowsHide` {boolean} Hide the subprocess console window that would
1406
1406
normally be created on Windows systems. **Default:** ` false ` .
1407
1407
* Returns: {Object}
1408
- * ` pid` {number } Pid of the child process.
1408
+ * ` pid` {integer } Pid of the child process.
1409
1409
* ` output` {Array} Array of results from stdio output.
1410
1410
* ` stdout` {Buffer|string} The contents of ` output[1 ]` .
1411
1411
* ` stderr` {Buffer|string} The contents of ` output[2 ]` .
1412
- * ` status` {number |null} The exit code of the subprocess, or ` null ` if the
1412
+ * ` status` {integer |null} The exit code of the subprocess, or ` null ` if the
1413
1413
subprocess terminated due to a signal.
1414
1414
* ` signal` {string|null} The signal used to kill the subprocess, or ` null ` if
1415
1415
the subprocess did not terminate due to a signal.
@@ -1448,7 +1448,7 @@ instances of `ChildProcess`.
1448
1448
added: v0.7.7
1449
1449
-->
1450
1450
1451
- * ` code` {number } The exit code if the child process exited on its own, or
1451
+ * ` code` {integer } The exit code if the child process exited on its own, or
1452
1452
` null ` if the child process terminated due to a signal.
1453
1453
* ` signal` {string} The signal by which the child process was terminated, or
1454
1454
` null ` if the child process did not terminated due to a signal.
@@ -1533,7 +1533,7 @@ See also [`subprocess.kill()`][] and [`subprocess.send()`][].
1533
1533
added: v0.1.90
1534
1534
-->
1535
1535
1536
- * ` code` {number } The exit code if the child process exited on its own, or
1536
+ * ` code` {integer } The exit code if the child process exited on its own, or
1537
1537
` null ` if the child process terminated due to a signal.
1538
1538
* ` signal` {string} The signal by which the child process was terminated, or
1539
1539
` null ` if the child process did not terminated due to a signal.
@@ -1673,7 +1673,7 @@ If the child process is still running, the field will be `null`.
1673
1673
added: v0.1.90
1674
1674
-->
1675
1675
1676
- * ` signal` {number |string}
1676
+ * ` signal` {integer |string}
1677
1677
* Returns: {boolean}
1678
1678
1679
1679
The ` subprocess .kill ()` method sends a signal to the child process. If no
0 commit comments