File size: 69,191 Bytes
f9f0fec |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 |
/**
* The `node:child_process` module provides the ability to spawn subprocesses in
* a manner that is similar, but not identical, to [`popen(3)`](http://man7.org/linux/man-pages/man3/popen.3.html). This capability
* is primarily provided by the {@link spawn} function:
*
* ```js
* const { spawn } = require('node:child_process');
* const ls = spawn('ls', ['-lh', '/usr']);
*
* ls.stdout.on('data', (data) => {
* console.log(`stdout: ${data}`);
* });
*
* ls.stderr.on('data', (data) => {
* console.error(`stderr: ${data}`);
* });
*
* ls.on('close', (code) => {
* console.log(`child process exited with code ${code}`);
* });
* ```
*
* By default, pipes for `stdin`, `stdout`, and `stderr` are established between
* the parent Node.js process and the spawned subprocess. These pipes have
* limited (and platform-specific) capacity. If the subprocess writes to
* stdout in excess of that limit without the output being captured, the
* subprocess blocks waiting for the pipe buffer to accept more data. This is
* identical to the behavior of pipes in the shell. Use the `{ stdio: 'ignore' }`option if the output will not be consumed.
*
* The command lookup is performed using the `options.env.PATH` environment
* variable if `env` is in the `options` object. Otherwise, `process.env.PATH` is
* used. If `options.env` is set without `PATH`, lookup on Unix is performed
* on a default search path search of `/usr/bin:/bin` (see your operating system's
* manual for execvpe/execvp), on Windows the current processes environment
* variable `PATH` is used.
*
* On Windows, environment variables are case-insensitive. Node.js
* lexicographically sorts the `env` keys and uses the first one that
* case-insensitively matches. Only first (in lexicographic order) entry will be
* passed to the subprocess. This might lead to issues on Windows when passing
* objects to the `env` option that have multiple variants of the same key, such as`PATH` and `Path`.
*
* The {@link spawn} method spawns the child process asynchronously,
* without blocking the Node.js event loop. The {@link spawnSync} function provides equivalent functionality in a synchronous manner that blocks
* the event loop until the spawned process either exits or is terminated.
*
* For convenience, the `node:child_process` module provides a handful of
* synchronous and asynchronous alternatives to {@link spawn} and {@link spawnSync}. Each of these alternatives are implemented on
* top of {@link spawn} or {@link spawnSync}.
*
* * {@link exec}: spawns a shell and runs a command within that
* shell, passing the `stdout` and `stderr` to a callback function when
* complete.
* * {@link execFile}: similar to {@link exec} except
* that it spawns the command directly without first spawning a shell by
* default.
* * {@link fork}: spawns a new Node.js process and invokes a
* specified module with an IPC communication channel established that allows
* sending messages between parent and child.
* * {@link execSync}: a synchronous version of {@link exec} that will block the Node.js event loop.
* * {@link execFileSync}: a synchronous version of {@link execFile} that will block the Node.js event loop.
*
* For certain use cases, such as automating shell scripts, the `synchronous counterparts` may be more convenient. In many cases, however,
* the synchronous methods can have significant impact on performance due to
* stalling the event loop while spawned processes complete.
* @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/child_process.js)
*/
declare module "child_process" {
import { ObjectEncodingOptions } from "node:fs";
import { Abortable, EventEmitter } from "node:events";
import * as net from "node:net";
import { Pipe, Readable, Stream, Writable } from "node:stream";
import { URL } from "node:url";
type Serializable = string | object | number | boolean | bigint;
type SendHandle = net.Socket | net.Server;
/**
* Instances of the `ChildProcess` represent spawned child processes.
*
* Instances of `ChildProcess` are not intended to be created directly. Rather,
* use the {@link spawn}, {@link exec},{@link execFile}, or {@link fork} methods to create
* instances of `ChildProcess`.
* @since v2.2.0
*/
class ChildProcess extends EventEmitter {
/**
* A `Writable Stream` that represents the child process's `stdin`.
*
* If a child process waits to read all of its input, the child will not continue
* until this stream has been closed via `end()`.
*
* If the child was spawned with `stdio[0]` set to anything other than `'pipe'`,
* then this will be `null`.
*
* `subprocess.stdin` is an alias for `subprocess.stdio[0]`. Both properties will
* refer to the same value.
*
* The `subprocess.stdin` property can be `null` or `undefined`if the child process could not be successfully spawned.
* @since v0.1.90
*/
stdin: Writable | null;
/**
* A `Readable Stream` that represents the child process's `stdout`.
*
* If the child was spawned with `stdio[1]` set to anything other than `'pipe'`,
* then this will be `null`.
*
* `subprocess.stdout` is an alias for `subprocess.stdio[1]`. Both properties will
* refer to the same value.
*
* ```js
* const { spawn } = require('node:child_process');
*
* const subprocess = spawn('ls');
*
* subprocess.stdout.on('data', (data) => {
* console.log(`Received chunk ${data}`);
* });
* ```
*
* The `subprocess.stdout` property can be `null` or `undefined`if the child process could not be successfully spawned.
* @since v0.1.90
*/
stdout: Readable | null;
/**
* A `Readable Stream` that represents the child process's `stderr`.
*
* If the child was spawned with `stdio[2]` set to anything other than `'pipe'`,
* then this will be `null`.
*
* `subprocess.stderr` is an alias for `subprocess.stdio[2]`. Both properties will
* refer to the same value.
*
* The `subprocess.stderr` property can be `null` or `undefined`if the child process could not be successfully spawned.
* @since v0.1.90
*/
stderr: Readable | null;
/**
* The `subprocess.channel` property is a reference to the child's IPC channel. If
* no IPC channel exists, this property is `undefined`.
* @since v7.1.0
*/
readonly channel?: Pipe | null | undefined;
/**
* A sparse array of pipes to the child process, corresponding with positions in
* the `stdio` option passed to {@link spawn} that have been set
* to the value `'pipe'`. `subprocess.stdio[0]`, `subprocess.stdio[1]`, and`subprocess.stdio[2]` are also available as `subprocess.stdin`,`subprocess.stdout`, and `subprocess.stderr`,
* respectively.
*
* In the following example, only the child's fd `1` (stdout) is configured as a
* pipe, so only the parent's `subprocess.stdio[1]` is a stream, all other values
* in the array are `null`.
*
* ```js
* const assert = require('node:assert');
* const fs = require('node:fs');
* const child_process = require('node:child_process');
*
* const subprocess = child_process.spawn('ls', {
* stdio: [
* 0, // Use parent's stdin for child.
* 'pipe', // Pipe child's stdout to parent.
* fs.openSync('err.out', 'w'), // Direct child's stderr to a file.
* ],
* });
*
* assert.strictEqual(subprocess.stdio[0], null);
* assert.strictEqual(subprocess.stdio[0], subprocess.stdin);
*
* assert(subprocess.stdout);
* assert.strictEqual(subprocess.stdio[1], subprocess.stdout);
*
* assert.strictEqual(subprocess.stdio[2], null);
* assert.strictEqual(subprocess.stdio[2], subprocess.stderr);
* ```
*
* The `subprocess.stdio` property can be `undefined` if the child process could
* not be successfully spawned.
* @since v0.7.10
*/
readonly stdio: [
Writable | null,
// stdin
Readable | null,
// stdout
Readable | null,
// stderr
Readable | Writable | null | undefined,
// extra
Readable | Writable | null | undefined, // extra
];
/**
* The `subprocess.killed` property indicates whether the child process
* successfully received a signal from `subprocess.kill()`. The `killed` property
* does not indicate that the child process has been terminated.
* @since v0.5.10
*/
readonly killed: boolean;
/**
* Returns the process identifier (PID) of the child process. If the child process
* fails to spawn due to errors, then the value is `undefined` and `error` is
* emitted.
*
* ```js
* const { spawn } = require('node:child_process');
* const grep = spawn('grep', ['ssh']);
*
* console.log(`Spawned child pid: ${grep.pid}`);
* grep.stdin.end();
* ```
* @since v0.1.90
*/
readonly pid?: number | undefined;
/**
* The `subprocess.connected` property indicates whether it is still possible to
* send and receive messages from a child process. When `subprocess.connected` is`false`, it is no longer possible to send or receive messages.
* @since v0.7.2
*/
readonly connected: boolean;
/**
* The `subprocess.exitCode` property indicates the exit code of the child process.
* If the child process is still running, the field will be `null`.
*/
readonly exitCode: number | null;
/**
* The `subprocess.signalCode` property indicates the signal received by
* the child process if any, else `null`.
*/
readonly signalCode: NodeJS.Signals | null;
/**
* The `subprocess.spawnargs` property represents the full list of command-line
* arguments the child process was launched with.
*/
readonly spawnargs: string[];
/**
* The `subprocess.spawnfile` property indicates the executable file name of
* the child process that is launched.
*
* For {@link fork}, its value will be equal to `process.execPath`.
* For {@link spawn}, its value will be the name of
* the executable file.
* For {@link exec}, its value will be the name of the shell
* in which the child process is launched.
*/
readonly spawnfile: string;
/**
* The `subprocess.kill()` method sends a signal to the child process. If no
* argument is given, the process will be sent the `'SIGTERM'` signal. See [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html) for a list of available signals. This function
* returns `true` if [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) succeeds, and `false` otherwise.
*
* ```js
* const { spawn } = require('node:child_process');
* const grep = spawn('grep', ['ssh']);
*
* grep.on('close', (code, signal) => {
* console.log(
* `child process terminated due to receipt of signal ${signal}`);
* });
*
* // Send SIGHUP to process.
* grep.kill('SIGHUP');
* ```
*
* The `ChildProcess` object may emit an `'error'` event if the signal
* cannot be delivered. Sending a signal to a child process that has already exited
* is not an error but may have unforeseen consequences. Specifically, if the
* process identifier (PID) has been reassigned to another process, the signal will
* be delivered to that process instead which can have unexpected results.
*
* While the function is called `kill`, the signal delivered to the child process
* may not actually terminate the process.
*
* See [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) for reference.
*
* On Windows, where POSIX signals do not exist, the `signal` argument will be
* ignored, and the process will be killed forcefully and abruptly (similar to`'SIGKILL'`).
* See `Signal Events` for more details.
*
* On Linux, child processes of child processes will not be terminated
* when attempting to kill their parent. This is likely to happen when running a
* new process in a shell or with the use of the `shell` option of `ChildProcess`:
*
* ```js
* 'use strict';
* const { spawn } = require('node:child_process');
*
* const subprocess = spawn(
* 'sh',
* [
* '-c',
* `node -e "setInterval(() => {
* console.log(process.pid, 'is alive')
* }, 500);"`,
* ], {
* stdio: ['inherit', 'inherit', 'inherit'],
* },
* );
*
* setTimeout(() => {
* subprocess.kill(); // Does not terminate the Node.js process in the shell.
* }, 2000);
* ```
* @since v0.1.90
*/
kill(signal?: NodeJS.Signals | number): boolean;
/**
* Calls {@link ChildProcess.kill} with `'SIGTERM'`.
* @since v20.5.0
*/
[Symbol.dispose](): void;
/**
* When an IPC channel has been established between the parent and child (
* i.e. when using {@link fork}), the `subprocess.send()` method can
* be used to send messages to the child process. When the child process is a
* Node.js instance, these messages can be received via the `'message'` event.
*
* The message goes through serialization and parsing. The resulting
* message might not be the same as what is originally sent.
*
* For example, in the parent script:
*
* ```js
* const cp = require('node:child_process');
* const n = cp.fork(`${__dirname}/sub.js`);
*
* n.on('message', (m) => {
* console.log('PARENT got message:', m);
* });
*
* // Causes the child to print: CHILD got message: { hello: 'world' }
* n.send({ hello: 'world' });
* ```
*
* And then the child script, `'sub.js'` might look like this:
*
* ```js
* process.on('message', (m) => {
* console.log('CHILD got message:', m);
* });
*
* // Causes the parent to print: PARENT got message: { foo: 'bar', baz: null }
* process.send({ foo: 'bar', baz: NaN });
* ```
*
* Child Node.js processes will have a `process.send()` method of their own
* that allows the child to send messages back to the parent.
*
* There is a special case when sending a `{cmd: 'NODE_foo'}` message. Messages
* containing a `NODE_` prefix in the `cmd` property are reserved for use within
* Node.js core and will not be emitted in the child's `'message'` event. Rather, such messages are emitted using the`'internalMessage'` event and are consumed internally by Node.js.
* Applications should avoid using such messages or listening for`'internalMessage'` events as it is subject to change without notice.
*
* The optional `sendHandle` argument that may be passed to `subprocess.send()` is
* for passing a TCP server or socket object to the child process. The child will
* receive the object as the second argument passed to the callback function
* registered on the `'message'` event. Any data that is received
* and buffered in the socket will not be sent to the child.
*
* The optional `callback` is a function that is invoked after the message is
* sent but before the child may have received it. The function is called with a
* single argument: `null` on success, or an `Error` object on failure.
*
* If no `callback` function is provided and the message cannot be sent, an`'error'` event will be emitted by the `ChildProcess` object. This can
* happen, for instance, when the child process has already exited.
*
* `subprocess.send()` will return `false` if the channel has closed or when the
* backlog of unsent messages exceeds a threshold that makes it unwise to send
* more. Otherwise, the method returns `true`. The `callback` function can be
* used to implement flow control.
*
* #### Example: sending a server object
*
* The `sendHandle` argument can be used, for instance, to pass the handle of
* a TCP server object to the child process as illustrated in the example below:
*
* ```js
* const subprocess = require('node:child_process').fork('subprocess.js');
*
* // Open up the server object and send the handle.
* const server = require('node:net').createServer();
* server.on('connection', (socket) => {
* socket.end('handled by parent');
* });
* server.listen(1337, () => {
* subprocess.send('server', server);
* });
* ```
*
* The child would then receive the server object as:
*
* ```js
* process.on('message', (m, server) => {
* if (m === 'server') {
* server.on('connection', (socket) => {
* socket.end('handled by child');
* });
* }
* });
* ```
*
* Once the server is now shared between the parent and child, some connections
* can be handled by the parent and some by the child.
*
* While the example above uses a server created using the `node:net` module,`node:dgram` module servers use exactly the same workflow with the exceptions of
* listening on a `'message'` event instead of `'connection'` and using`server.bind()` instead of `server.listen()`. This is, however, only
* supported on Unix platforms.
*
* #### Example: sending a socket object
*
* Similarly, the `sendHandler` argument can be used to pass the handle of a
* socket to the child process. The example below spawns two children that each
* handle connections with "normal" or "special" priority:
*
* ```js
* const { fork } = require('node:child_process');
* const normal = fork('subprocess.js', ['normal']);
* const special = fork('subprocess.js', ['special']);
*
* // Open up the server and send sockets to child. Use pauseOnConnect to prevent
* // the sockets from being read before they are sent to the child process.
* const server = require('node:net').createServer({ pauseOnConnect: true });
* server.on('connection', (socket) => {
*
* // If this is special priority...
* if (socket.remoteAddress === '74.125.127.100') {
* special.send('socket', socket);
* return;
* }
* // This is normal priority.
* normal.send('socket', socket);
* });
* server.listen(1337);
* ```
*
* The `subprocess.js` would receive the socket handle as the second argument
* passed to the event callback function:
*
* ```js
* process.on('message', (m, socket) => {
* if (m === 'socket') {
* if (socket) {
* // Check that the client socket exists.
* // It is possible for the socket to be closed between the time it is
* // sent and the time it is received in the child process.
* socket.end(`Request handled with ${process.argv[2]} priority`);
* }
* }
* });
* ```
*
* Do not use `.maxConnections` on a socket that has been passed to a subprocess.
* The parent cannot track when the socket is destroyed.
*
* Any `'message'` handlers in the subprocess should verify that `socket` exists,
* as the connection may have been closed during the time it takes to send the
* connection to the child.
* @since v0.5.9
* @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties:
*/
send(message: Serializable, callback?: (error: Error | null) => void): boolean;
send(message: Serializable, sendHandle?: SendHandle, callback?: (error: Error | null) => void): boolean;
send(
message: Serializable,
sendHandle?: SendHandle,
options?: MessageOptions,
callback?: (error: Error | null) => void,
): boolean;
/**
* Closes the IPC channel between parent and child, allowing the child to exit
* gracefully once there are no other connections keeping it alive. After calling
* this method the `subprocess.connected` and `process.connected` properties in
* both the parent and child (respectively) will be set to `false`, and it will be
* no longer possible to pass messages between the processes.
*
* The `'disconnect'` event will be emitted when there are no messages in the
* process of being received. This will most often be triggered immediately after
* calling `subprocess.disconnect()`.
*
* When the child process is a Node.js instance (e.g. spawned using {@link fork}), the `process.disconnect()` method can be invoked
* within the child process to close the IPC channel as well.
* @since v0.7.2
*/
disconnect(): void;
/**
* By default, the parent will wait for the detached child to exit. To prevent the
* parent from waiting for a given `subprocess` to exit, use the`subprocess.unref()` method. Doing so will cause the parent's event loop to not
* include the child in its reference count, allowing the parent to exit
* independently of the child, unless there is an established IPC channel between
* the child and the parent.
*
* ```js
* const { spawn } = require('node:child_process');
*
* const subprocess = spawn(process.argv[0], ['child_program.js'], {
* detached: true,
* stdio: 'ignore',
* });
*
* subprocess.unref();
* ```
* @since v0.7.10
*/
unref(): void;
/**
* Calling `subprocess.ref()` after making a call to `subprocess.unref()` will
* restore the removed reference count for the child process, forcing the parent
* to wait for the child to exit before exiting itself.
*
* ```js
* const { spawn } = require('node:child_process');
*
* const subprocess = spawn(process.argv[0], ['child_program.js'], {
* detached: true,
* stdio: 'ignore',
* });
*
* subprocess.unref();
* subprocess.ref();
* ```
* @since v0.7.10
*/
ref(): void;
/**
* events.EventEmitter
* 1. close
* 2. disconnect
* 3. error
* 4. exit
* 5. message
* 6. spawn
*/
addListener(event: string, listener: (...args: any[]) => void): this;
addListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
addListener(event: "disconnect", listener: () => void): this;
addListener(event: "error", listener: (err: Error) => void): this;
addListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
addListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
addListener(event: "spawn", listener: () => void): this;
emit(event: string | symbol, ...args: any[]): boolean;
emit(event: "close", code: number | null, signal: NodeJS.Signals | null): boolean;
emit(event: "disconnect"): boolean;
emit(event: "error", err: Error): boolean;
emit(event: "exit", code: number | null, signal: NodeJS.Signals | null): boolean;
emit(event: "message", message: Serializable, sendHandle: SendHandle): boolean;
emit(event: "spawn", listener: () => void): boolean;
on(event: string, listener: (...args: any[]) => void): this;
on(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
on(event: "disconnect", listener: () => void): this;
on(event: "error", listener: (err: Error) => void): this;
on(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
on(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
on(event: "spawn", listener: () => void): this;
once(event: string, listener: (...args: any[]) => void): this;
once(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
once(event: "disconnect", listener: () => void): this;
once(event: "error", listener: (err: Error) => void): this;
once(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
once(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
once(event: "spawn", listener: () => void): this;
prependListener(event: string, listener: (...args: any[]) => void): this;
prependListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
prependListener(event: "disconnect", listener: () => void): this;
prependListener(event: "error", listener: (err: Error) => void): this;
prependListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
prependListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
prependListener(event: "spawn", listener: () => void): this;
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
prependOnceListener(
event: "close",
listener: (code: number | null, signal: NodeJS.Signals | null) => void,
): this;
prependOnceListener(event: "disconnect", listener: () => void): this;
prependOnceListener(event: "error", listener: (err: Error) => void): this;
prependOnceListener(
event: "exit",
listener: (code: number | null, signal: NodeJS.Signals | null) => void,
): this;
prependOnceListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
prependOnceListener(event: "spawn", listener: () => void): this;
}
// return this object when stdio option is undefined or not specified
interface ChildProcessWithoutNullStreams extends ChildProcess {
stdin: Writable;
stdout: Readable;
stderr: Readable;
readonly stdio: [
Writable,
Readable,
Readable,
// stderr
Readable | Writable | null | undefined,
// extra, no modification
Readable | Writable | null | undefined, // extra, no modification
];
}
// return this object when stdio option is a tuple of 3
interface ChildProcessByStdio<I extends null | Writable, O extends null | Readable, E extends null | Readable>
extends ChildProcess
{
stdin: I;
stdout: O;
stderr: E;
readonly stdio: [
I,
O,
E,
Readable | Writable | null | undefined,
// extra, no modification
Readable | Writable | null | undefined, // extra, no modification
];
}
interface MessageOptions {
keepOpen?: boolean | undefined;
}
type IOType = "overlapped" | "pipe" | "ignore" | "inherit";
type StdioOptions = IOType | Array<IOType | "ipc" | Stream | number | null | undefined>;
type SerializationType = "json" | "advanced";
interface MessagingOptions extends Abortable {
/**
* Specify the kind of serialization used for sending messages between processes.
* @default 'json'
*/
serialization?: SerializationType | undefined;
/**
* The signal value to be used when the spawned process will be killed by the abort signal.
* @default 'SIGTERM'
*/
killSignal?: NodeJS.Signals | number | undefined;
/**
* In milliseconds the maximum amount of time the process is allowed to run.
*/
timeout?: number | undefined;
}
interface ProcessEnvOptions {
uid?: number | undefined;
gid?: number | undefined;
cwd?: string | URL | undefined;
env?: NodeJS.ProcessEnv | undefined;
}
interface CommonOptions extends ProcessEnvOptions {
/**
* @default false
*/
windowsHide?: boolean | undefined;
/**
* @default 0
*/
timeout?: number | undefined;
}
interface CommonSpawnOptions extends CommonOptions, MessagingOptions, Abortable {
argv0?: string | undefined;
/**
* Can be set to 'pipe', 'inherit', 'overlapped', or 'ignore', or an array of these strings.
* If passed as an array, the first element is used for `stdin`, the second for
* `stdout`, and the third for `stderr`. A fourth element can be used to
* specify the `stdio` behavior beyond the standard streams. See
* {@link ChildProcess.stdio} for more information.
*
* @default 'pipe'
*/
stdio?: StdioOptions | undefined;
shell?: boolean | string | undefined;
windowsVerbatimArguments?: boolean | undefined;
}
interface SpawnOptions extends CommonSpawnOptions {
detached?: boolean | undefined;
}
interface SpawnOptionsWithoutStdio extends SpawnOptions {
stdio?: StdioPipeNamed | StdioPipe[] | undefined;
}
type StdioNull = "inherit" | "ignore" | Stream;
type StdioPipeNamed = "pipe" | "overlapped";
type StdioPipe = undefined | null | StdioPipeNamed;
interface SpawnOptionsWithStdioTuple<
Stdin extends StdioNull | StdioPipe,
Stdout extends StdioNull | StdioPipe,
Stderr extends StdioNull | StdioPipe,
> extends SpawnOptions {
stdio: [Stdin, Stdout, Stderr];
}
/**
* The `child_process.spawn()` method spawns a new process using the given`command`, with command-line arguments in `args`. If omitted, `args` defaults
* to an empty array.
*
* **If the `shell` option is enabled, do not pass unsanitized user input to this**
* **function. Any input containing shell metacharacters may be used to trigger**
* **arbitrary command execution.**
*
* A third argument may be used to specify additional options, with these defaults:
*
* ```js
* const defaults = {
* cwd: undefined,
* env: process.env,
* };
* ```
*
* Use `cwd` to specify the working directory from which the process is spawned.
* If not given, the default is to inherit the current working directory. If given,
* but the path does not exist, the child process emits an `ENOENT` error
* and exits immediately. `ENOENT` is also emitted when the command
* does not exist.
*
* Use `env` to specify environment variables that will be visible to the new
* process, the default is `process.env`.
*
* `undefined` values in `env` will be ignored.
*
* Example of running `ls -lh /usr`, capturing `stdout`, `stderr`, and the
* exit code:
*
* ```js
* const { spawn } = require('node:child_process');
* const ls = spawn('ls', ['-lh', '/usr']);
*
* ls.stdout.on('data', (data) => {
* console.log(`stdout: ${data}`);
* });
*
* ls.stderr.on('data', (data) => {
* console.error(`stderr: ${data}`);
* });
*
* ls.on('close', (code) => {
* console.log(`child process exited with code ${code}`);
* });
* ```
*
* Example: A very elaborate way to run `ps ax | grep ssh`
*
* ```js
* const { spawn } = require('node:child_process');
* const ps = spawn('ps', ['ax']);
* const grep = spawn('grep', ['ssh']);
*
* ps.stdout.on('data', (data) => {
* grep.stdin.write(data);
* });
*
* ps.stderr.on('data', (data) => {
* console.error(`ps stderr: ${data}`);
* });
*
* ps.on('close', (code) => {
* if (code !== 0) {
* console.log(`ps process exited with code ${code}`);
* }
* grep.stdin.end();
* });
*
* grep.stdout.on('data', (data) => {
* console.log(data.toString());
* });
*
* grep.stderr.on('data', (data) => {
* console.error(`grep stderr: ${data}`);
* });
*
* grep.on('close', (code) => {
* if (code !== 0) {
* console.log(`grep process exited with code ${code}`);
* }
* });
* ```
*
* Example of checking for failed `spawn`:
*
* ```js
* const { spawn } = require('node:child_process');
* const subprocess = spawn('bad_command');
*
* subprocess.on('error', (err) => {
* console.error('Failed to start subprocess.');
* });
* ```
*
* Certain platforms (macOS, Linux) will use the value of `argv[0]` for the process
* title while others (Windows, SunOS) will use `command`.
*
* Node.js overwrites `argv[0]` with `process.execPath` on startup, so`process.argv[0]` in a Node.js child process will not match the `argv0`parameter passed to `spawn` from the parent. Retrieve
* it with the`process.argv0` property instead.
*
* If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except
* the error passed to the callback will be an `AbortError`:
*
* ```js
* const { spawn } = require('node:child_process');
* const controller = new AbortController();
* const { signal } = controller;
* const grep = spawn('grep', ['ssh'], { signal });
* grep.on('error', (err) => {
* // This will be called with err being an AbortError if the controller aborts
* });
* controller.abort(); // Stops the child process
* ```
* @since v0.1.90
* @param command The command to run.
* @param args List of string arguments.
*/
function spawn(command: string, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams;
function spawn(
command: string,
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>,
): ChildProcessByStdio<Writable, Readable, Readable>;
function spawn(
command: string,
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>,
): ChildProcessByStdio<Writable, Readable, null>;
function spawn(
command: string,
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>,
): ChildProcessByStdio<Writable, null, Readable>;
function spawn(
command: string,
options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>,
): ChildProcessByStdio<null, Readable, Readable>;
function spawn(
command: string,
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>,
): ChildProcessByStdio<Writable, null, null>;
function spawn(
command: string,
options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>,
): ChildProcessByStdio<null, Readable, null>;
function spawn(
command: string,
options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>,
): ChildProcessByStdio<null, null, Readable>;
function spawn(
command: string,
options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>,
): ChildProcessByStdio<null, null, null>;
function spawn(command: string, options: SpawnOptions): ChildProcess;
// overloads of spawn with 'args'
function spawn(
command: string,
args?: readonly string[],
options?: SpawnOptionsWithoutStdio,
): ChildProcessWithoutNullStreams;
function spawn(
command: string,
args: readonly string[],
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>,
): ChildProcessByStdio<Writable, Readable, Readable>;
function spawn(
command: string,
args: readonly string[],
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>,
): ChildProcessByStdio<Writable, Readable, null>;
function spawn(
command: string,
args: readonly string[],
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>,
): ChildProcessByStdio<Writable, null, Readable>;
function spawn(
command: string,
args: readonly string[],
options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>,
): ChildProcessByStdio<null, Readable, Readable>;
function spawn(
command: string,
args: readonly string[],
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>,
): ChildProcessByStdio<Writable, null, null>;
function spawn(
command: string,
args: readonly string[],
options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>,
): ChildProcessByStdio<null, Readable, null>;
function spawn(
command: string,
args: readonly string[],
options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>,
): ChildProcessByStdio<null, null, Readable>;
function spawn(
command: string,
args: readonly string[],
options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>,
): ChildProcessByStdio<null, null, null>;
function spawn(command: string, args: readonly string[], options: SpawnOptions): ChildProcess;
interface ExecOptions extends CommonOptions {
shell?: string | undefined;
signal?: AbortSignal | undefined;
maxBuffer?: number | undefined;
killSignal?: NodeJS.Signals | number | undefined;
}
interface ExecOptionsWithStringEncoding extends ExecOptions {
encoding: BufferEncoding;
}
interface ExecOptionsWithBufferEncoding extends ExecOptions {
encoding: BufferEncoding | null; // specify `null`.
}
interface ExecException extends Error {
cmd?: string | undefined;
killed?: boolean | undefined;
code?: number | undefined;
signal?: NodeJS.Signals | undefined;
}
/**
* Spawns a shell then executes the `command` within that shell, buffering any
* generated output. The `command` string passed to the exec function is processed
* directly by the shell and special characters (vary based on [shell](https://en.wikipedia.org/wiki/List_of_command-line_interpreters))
* need to be dealt with accordingly:
*
* ```js
* const { exec } = require('node:child_process');
*
* exec('"/path/to/test file/test.sh" arg1 arg2');
* // Double quotes are used so that the space in the path is not interpreted as
* // a delimiter of multiple arguments.
*
* exec('echo "The \\$HOME variable is $HOME"');
* // The $HOME variable is escaped in the first instance, but not in the second.
* ```
*
* **Never pass unsanitized user input to this function. Any input containing shell**
* **metacharacters may be used to trigger arbitrary command execution.**
*
* If a `callback` function is provided, it is called with the arguments`(error, stdout, stderr)`. On success, `error` will be `null`. On error,`error` will be an instance of `Error`. The
* `error.code` property will be
* the exit code of the process. By convention, any exit code other than `0`indicates an error. `error.signal` will be the signal that terminated the
* process.
*
* The `stdout` and `stderr` arguments passed to the callback will contain the
* stdout and stderr output of the child process. By default, Node.js will decode
* the output as UTF-8 and pass strings to the callback. The `encoding` option
* can be used to specify the character encoding used to decode the stdout and
* stderr output. If `encoding` is `'buffer'`, or an unrecognized character
* encoding, `Buffer` objects will be passed to the callback instead.
*
* ```js
* const { exec } = require('node:child_process');
* exec('cat *.js missing_file | wc -l', (error, stdout, stderr) => {
* if (error) {
* console.error(`exec error: ${error}`);
* return;
* }
* console.log(`stdout: ${stdout}`);
* console.error(`stderr: ${stderr}`);
* });
* ```
*
* If `timeout` is greater than `0`, the parent will send the signal
* identified by the `killSignal` property (the default is `'SIGTERM'`) if the
* child runs longer than `timeout` milliseconds.
*
* Unlike the [`exec(3)`](http://man7.org/linux/man-pages/man3/exec.3.html) POSIX system call, `child_process.exec()` does not replace
* the existing process and uses a shell to execute the command.
*
* If this method is invoked as its `util.promisify()` ed version, it returns
* a `Promise` for an `Object` with `stdout` and `stderr` properties. The returned`ChildProcess` instance is attached to the `Promise` as a `child` property. In
* case of an error (including any error resulting in an exit code other than 0), a
* rejected promise is returned, with the same `error` object given in the
* callback, but with two additional properties `stdout` and `stderr`.
*
* ```js
* const util = require('node:util');
* const exec = util.promisify(require('node:child_process').exec);
*
* async function lsExample() {
* const { stdout, stderr } = await exec('ls');
* console.log('stdout:', stdout);
* console.error('stderr:', stderr);
* }
* lsExample();
* ```
*
* If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except
* the error passed to the callback will be an `AbortError`:
*
* ```js
* const { exec } = require('node:child_process');
* const controller = new AbortController();
* const { signal } = controller;
* const child = exec('grep ssh', { signal }, (error) => {
* console.error(error); // an AbortError
* });
* controller.abort();
* ```
* @since v0.1.90
* @param command The command to run, with space-separated arguments.
* @param callback called with the output when process terminates.
*/
function exec(
command: string,
callback?: (error: ExecException | null, stdout: string, stderr: string) => void,
): ChildProcess;
// `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`.
function exec(
command: string,
options: {
encoding: "buffer" | null;
} & ExecOptions,
callback?: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void,
): ChildProcess;
// `options` with well known `encoding` means stdout/stderr are definitely `string`.
function exec(
command: string,
options: {
encoding: BufferEncoding;
} & ExecOptions,
callback?: (error: ExecException | null, stdout: string, stderr: string) => void,
): ChildProcess;
// `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`.
// There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`.
function exec(
command: string,
options: {
encoding: BufferEncoding;
} & ExecOptions,
callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
): ChildProcess;
// `options` without an `encoding` means stdout/stderr are definitely `string`.
function exec(
command: string,
options: ExecOptions,
callback?: (error: ExecException | null, stdout: string, stderr: string) => void,
): ChildProcess;
// fallback if nothing else matches. Worst case is always `string | Buffer`.
function exec(
command: string,
options: (ObjectEncodingOptions & ExecOptions) | undefined | null,
callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
): ChildProcess;
interface PromiseWithChild<T> extends Promise<T> {
child: ChildProcess;
}
namespace exec {
function __promisify__(command: string): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
command: string,
options: {
encoding: "buffer" | null;
} & ExecOptions,
): PromiseWithChild<{
stdout: Buffer;
stderr: Buffer;
}>;
function __promisify__(
command: string,
options: {
encoding: BufferEncoding;
} & ExecOptions,
): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
command: string,
options: ExecOptions,
): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
command: string,
options?: (ObjectEncodingOptions & ExecOptions) | null,
): PromiseWithChild<{
stdout: string | Buffer;
stderr: string | Buffer;
}>;
}
interface ExecFileOptions extends CommonOptions, Abortable {
maxBuffer?: number | undefined;
killSignal?: NodeJS.Signals | number | undefined;
windowsVerbatimArguments?: boolean | undefined;
shell?: boolean | string | undefined;
signal?: AbortSignal | undefined;
}
interface ExecFileOptionsWithStringEncoding extends ExecFileOptions {
encoding: BufferEncoding;
}
interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions {
encoding: "buffer" | null;
}
interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions {
encoding: BufferEncoding;
}
type ExecFileException =
& Omit<ExecException, "code">
& Omit<NodeJS.ErrnoException, "code">
& { code?: string | number | undefined | null };
/**
* The `child_process.execFile()` function is similar to {@link exec} except that it does not spawn a shell by default. Rather, the specified
* executable `file` is spawned directly as a new process making it slightly more
* efficient than {@link exec}.
*
* The same options as {@link exec} are supported. Since a shell is
* not spawned, behaviors such as I/O redirection and file globbing are not
* supported.
*
* ```js
* const { execFile } = require('node:child_process');
* const child = execFile('node', ['--version'], (error, stdout, stderr) => {
* if (error) {
* throw error;
* }
* console.log(stdout);
* });
* ```
*
* The `stdout` and `stderr` arguments passed to the callback will contain the
* stdout and stderr output of the child process. By default, Node.js will decode
* the output as UTF-8 and pass strings to the callback. The `encoding` option
* can be used to specify the character encoding used to decode the stdout and
* stderr output. If `encoding` is `'buffer'`, or an unrecognized character
* encoding, `Buffer` objects will be passed to the callback instead.
*
* If this method is invoked as its `util.promisify()` ed version, it returns
* a `Promise` for an `Object` with `stdout` and `stderr` properties. The returned`ChildProcess` instance is attached to the `Promise` as a `child` property. In
* case of an error (including any error resulting in an exit code other than 0), a
* rejected promise is returned, with the same `error` object given in the
* callback, but with two additional properties `stdout` and `stderr`.
*
* ```js
* const util = require('node:util');
* const execFile = util.promisify(require('node:child_process').execFile);
* async function getVersion() {
* const { stdout } = await execFile('node', ['--version']);
* console.log(stdout);
* }
* getVersion();
* ```
*
* **If the `shell` option is enabled, do not pass unsanitized user input to this**
* **function. Any input containing shell metacharacters may be used to trigger**
* **arbitrary command execution.**
*
* If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except
* the error passed to the callback will be an `AbortError`:
*
* ```js
* const { execFile } = require('node:child_process');
* const controller = new AbortController();
* const { signal } = controller;
* const child = execFile('node', ['--version'], { signal }, (error) => {
* console.error(error); // an AbortError
* });
* controller.abort();
* ```
* @since v0.1.91
* @param file The name or path of the executable file to run.
* @param args List of string arguments.
* @param callback Called with the output when process terminates.
*/
function execFile(file: string): ChildProcess;
function execFile(
file: string,
options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
): ChildProcess;
function execFile(file: string, args?: readonly string[] | null): ChildProcess;
function execFile(
file: string,
args: readonly string[] | undefined | null,
options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
): ChildProcess;
// no `options` definitely means stdout/stderr are `string`.
function execFile(
file: string,
callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
): ChildProcess;
function execFile(
file: string,
args: readonly string[] | undefined | null,
callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
): ChildProcess;
// `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`.
function execFile(
file: string,
options: ExecFileOptionsWithBufferEncoding,
callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void,
): ChildProcess;
function execFile(
file: string,
args: readonly string[] | undefined | null,
options: ExecFileOptionsWithBufferEncoding,
callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void,
): ChildProcess;
// `options` with well known `encoding` means stdout/stderr are definitely `string`.
function execFile(
file: string,
options: ExecFileOptionsWithStringEncoding,
callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
): ChildProcess;
function execFile(
file: string,
args: readonly string[] | undefined | null,
options: ExecFileOptionsWithStringEncoding,
callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
): ChildProcess;
// `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`.
// There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`.
function execFile(
file: string,
options: ExecFileOptionsWithOtherEncoding,
callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
): ChildProcess;
function execFile(
file: string,
args: readonly string[] | undefined | null,
options: ExecFileOptionsWithOtherEncoding,
callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
): ChildProcess;
// `options` without an `encoding` means stdout/stderr are definitely `string`.
function execFile(
file: string,
options: ExecFileOptions,
callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
): ChildProcess;
function execFile(
file: string,
args: readonly string[] | undefined | null,
options: ExecFileOptions,
callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
): ChildProcess;
// fallback if nothing else matches. Worst case is always `string | Buffer`.
function execFile(
file: string,
options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
callback:
| ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void)
| undefined
| null,
): ChildProcess;
function execFile(
file: string,
args: readonly string[] | undefined | null,
options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
callback:
| ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void)
| undefined
| null,
): ChildProcess;
namespace execFile {
function __promisify__(file: string): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
file: string,
args: readonly string[] | undefined | null,
): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
file: string,
options: ExecFileOptionsWithBufferEncoding,
): PromiseWithChild<{
stdout: Buffer;
stderr: Buffer;
}>;
function __promisify__(
file: string,
args: readonly string[] | undefined | null,
options: ExecFileOptionsWithBufferEncoding,
): PromiseWithChild<{
stdout: Buffer;
stderr: Buffer;
}>;
function __promisify__(
file: string,
options: ExecFileOptionsWithStringEncoding,
): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
file: string,
args: readonly string[] | undefined | null,
options: ExecFileOptionsWithStringEncoding,
): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
file: string,
options: ExecFileOptionsWithOtherEncoding,
): PromiseWithChild<{
stdout: string | Buffer;
stderr: string | Buffer;
}>;
function __promisify__(
file: string,
args: readonly string[] | undefined | null,
options: ExecFileOptionsWithOtherEncoding,
): PromiseWithChild<{
stdout: string | Buffer;
stderr: string | Buffer;
}>;
function __promisify__(
file: string,
options: ExecFileOptions,
): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
file: string,
args: readonly string[] | undefined | null,
options: ExecFileOptions,
): PromiseWithChild<{
stdout: string;
stderr: string;
}>;
function __promisify__(
file: string,
options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
): PromiseWithChild<{
stdout: string | Buffer;
stderr: string | Buffer;
}>;
function __promisify__(
file: string,
args: readonly string[] | undefined | null,
options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
): PromiseWithChild<{
stdout: string | Buffer;
stderr: string | Buffer;
}>;
}
interface ForkOptions extends ProcessEnvOptions, MessagingOptions, Abortable {
execPath?: string | undefined;
execArgv?: string[] | undefined;
silent?: boolean | undefined;
/**
* Can be set to 'pipe', 'inherit', 'overlapped', or 'ignore', or an array of these strings.
* If passed as an array, the first element is used for `stdin`, the second for
* `stdout`, and the third for `stderr`. A fourth element can be used to
* specify the `stdio` behavior beyond the standard streams. See
* {@link ChildProcess.stdio} for more information.
*
* @default 'pipe'
*/
stdio?: StdioOptions | undefined;
detached?: boolean | undefined;
windowsVerbatimArguments?: boolean | undefined;
}
/**
* The `child_process.fork()` method is a special case of {@link spawn} used specifically to spawn new Node.js processes.
* Like {@link spawn}, a `ChildProcess` object is returned. The
* returned `ChildProcess` will have an additional communication channel
* built-in that allows messages to be passed back and forth between the parent and
* child. See `subprocess.send()` for details.
*
* Keep in mind that spawned Node.js child processes are
* independent of the parent with exception of the IPC communication channel
* that is established between the two. Each process has its own memory, with
* their own V8 instances. Because of the additional resource allocations
* required, spawning a large number of child Node.js processes is not
* recommended.
*
* By default, `child_process.fork()` will spawn new Node.js instances using the `process.execPath` of the parent process. The `execPath` property in the`options` object allows for an alternative
* execution path to be used.
*
* Node.js processes launched with a custom `execPath` will communicate with the
* parent process using the file descriptor (fd) identified using the
* environment variable `NODE_CHANNEL_FD` on the child process.
*
* Unlike the [`fork(2)`](http://man7.org/linux/man-pages/man2/fork.2.html) POSIX system call, `child_process.fork()` does not clone the
* current process.
*
* The `shell` option available in {@link spawn} is not supported by`child_process.fork()` and will be ignored if set.
*
* If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except
* the error passed to the callback will be an `AbortError`:
*
* ```js
* if (process.argv[2] === 'child') {
* setTimeout(() => {
* console.log(`Hello from ${process.argv[2]}!`);
* }, 1_000);
* } else {
* const { fork } = require('node:child_process');
* const controller = new AbortController();
* const { signal } = controller;
* const child = fork(__filename, ['child'], { signal });
* child.on('error', (err) => {
* // This will be called with err being an AbortError if the controller aborts
* });
* controller.abort(); // Stops the child process
* }
* ```
* @since v0.5.0
* @param modulePath The module to run in the child.
* @param args List of string arguments.
*/
function fork(modulePath: string, options?: ForkOptions): ChildProcess;
function fork(modulePath: string, args?: readonly string[], options?: ForkOptions): ChildProcess;
interface SpawnSyncOptions extends CommonSpawnOptions {
input?: string | NodeJS.ArrayBufferView | undefined;
maxBuffer?: number | undefined;
encoding?: BufferEncoding | "buffer" | null | undefined;
}
interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions {
encoding: BufferEncoding;
}
interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions {
encoding?: "buffer" | null | undefined;
}
interface SpawnSyncReturns<T> {
pid: number;
output: Array<T | null>;
stdout: T;
stderr: T;
status: number | null;
signal: NodeJS.Signals | null;
error?: Error | undefined;
}
/**
* The `child_process.spawnSync()` method is generally identical to {@link spawn} with the exception that the function will not return
* until the child process has fully closed. When a timeout has been encountered
* and `killSignal` is sent, the method won't return until the process has
* completely exited. If the process intercepts and handles the `SIGTERM` signal
* and doesn't exit, the parent process will wait until the child process has
* exited.
*
* **If the `shell` option is enabled, do not pass unsanitized user input to this**
* **function. Any input containing shell metacharacters may be used to trigger**
* **arbitrary command execution.**
* @since v0.11.12
* @param command The command to run.
* @param args List of string arguments.
*/
function spawnSync(command: string): SpawnSyncReturns<Buffer>;
function spawnSync(command: string, options: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns<string>;
function spawnSync(command: string, options: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns<Buffer>;
function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns<string | Buffer>;
function spawnSync(command: string, args: readonly string[]): SpawnSyncReturns<Buffer>;
function spawnSync(
command: string,
args: readonly string[],
options: SpawnSyncOptionsWithStringEncoding,
): SpawnSyncReturns<string>;
function spawnSync(
command: string,
args: readonly string[],
options: SpawnSyncOptionsWithBufferEncoding,
): SpawnSyncReturns<Buffer>;
function spawnSync(
command: string,
args?: readonly string[],
options?: SpawnSyncOptions,
): SpawnSyncReturns<string | Buffer>;
interface CommonExecOptions extends CommonOptions {
input?: string | NodeJS.ArrayBufferView | undefined;
/**
* Can be set to 'pipe', 'inherit, or 'ignore', or an array of these strings.
* If passed as an array, the first element is used for `stdin`, the second for
* `stdout`, and the third for `stderr`. A fourth element can be used to
* specify the `stdio` behavior beyond the standard streams. See
* {@link ChildProcess.stdio} for more information.
*
* @default 'pipe'
*/
stdio?: StdioOptions | undefined;
killSignal?: NodeJS.Signals | number | undefined;
maxBuffer?: number | undefined;
encoding?: BufferEncoding | "buffer" | null | undefined;
}
interface ExecSyncOptions extends CommonExecOptions {
shell?: string | undefined;
}
interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions {
encoding: BufferEncoding;
}
interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions {
encoding?: "buffer" | null | undefined;
}
/**
* The `child_process.execSync()` method is generally identical to {@link exec} with the exception that the method will not return
* until the child process has fully closed. When a timeout has been encountered
* and `killSignal` is sent, the method won't return until the process has
* completely exited. If the child process intercepts and handles the `SIGTERM`signal and doesn't exit, the parent process will wait until the child process
* has exited.
*
* If the process times out or has a non-zero exit code, this method will throw.
* The `Error` object will contain the entire result from {@link spawnSync}.
*
* **Never pass unsanitized user input to this function. Any input containing shell**
* **metacharacters may be used to trigger arbitrary command execution.**
* @since v0.11.12
* @param command The command to run.
* @return The stdout from the command.
*/
function execSync(command: string): Buffer;
function execSync(command: string, options: ExecSyncOptionsWithStringEncoding): string;
function execSync(command: string, options: ExecSyncOptionsWithBufferEncoding): Buffer;
function execSync(command: string, options?: ExecSyncOptions): string | Buffer;
interface ExecFileSyncOptions extends CommonExecOptions {
shell?: boolean | string | undefined;
}
interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions {
encoding: BufferEncoding;
}
interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions {
encoding?: "buffer" | null; // specify `null`.
}
/**
* The `child_process.execFileSync()` method is generally identical to {@link execFile} with the exception that the method will not
* return until the child process has fully closed. When a timeout has been
* encountered and `killSignal` is sent, the method won't return until the process
* has completely exited.
*
* If the child process intercepts and handles the `SIGTERM` signal and
* does not exit, the parent process will still wait until the child process has
* exited.
*
* If the process times out or has a non-zero exit code, this method will throw an `Error` that will include the full result of the underlying {@link spawnSync}.
*
* **If the `shell` option is enabled, do not pass unsanitized user input to this**
* **function. Any input containing shell metacharacters may be used to trigger**
* **arbitrary command execution.**
* @since v0.11.12
* @param file The name or path of the executable file to run.
* @param args List of string arguments.
* @return The stdout from the command.
*/
function execFileSync(file: string): Buffer;
function execFileSync(file: string, options: ExecFileSyncOptionsWithStringEncoding): string;
function execFileSync(file: string, options: ExecFileSyncOptionsWithBufferEncoding): Buffer;
function execFileSync(file: string, options?: ExecFileSyncOptions): string | Buffer;
function execFileSync(file: string, args: readonly string[]): Buffer;
function execFileSync(
file: string,
args: readonly string[],
options: ExecFileSyncOptionsWithStringEncoding,
): string;
function execFileSync(
file: string,
args: readonly string[],
options: ExecFileSyncOptionsWithBufferEncoding,
): Buffer;
function execFileSync(file: string, args?: readonly string[], options?: ExecFileSyncOptions): string | Buffer;
}
declare module "node:child_process" {
export * from "child_process";
}
|