child_process.execFile(file[, args][, options][, callback])

• file <string> 要运行的可执行文件的名称或路径。
• args <string[]> 参数列表。

• options <Object>

  • cwd <string> 子进程的当前工作目录。
  • env <Object> 环境变量键值对。
  • encoding <string> 字符编码。默认为 'utf8'。
  • timeout <number> 默认为 0。
  • maxBuffer <number> stdout 或 stderr 允许的最大字节数。如果超过限制，则子进程会终止。参阅 maxBuffer与Unicode。默认为 200*1024。
  • killSignal <string> | <integer> 默认为 'SIGTERM'。
  • uid <number> 进程的用户标识，参阅 setuid(2)。
  • gid <number> 进程的群组标识，参阅 setgid(2)。
  • windowsHide <boolean> 是否隐藏子进程的控制台窗口。默认为 false。
  • windowsVerbatimArguments <boolean> 在 Windows 上是否为参数加引号或转义。默认为 false。
  • shell <boolean> | <string> 如果设为 true，则在 shell 中运行 command。 在 UNIX 上使用 '/bin/sh'，在 Windows 上使用 process.env.ComSpec。 传入字符串则指定其他 shell。 参阅 Shell的要求与 Windows默认的Shell。 默认为 false（没有 shell）。

• callback <Function> 当进程终止时调用。

  • error <Error>
  • stdout <string> | <Buffer>
  • stderr <string> | <Buffer>
• 返回: <ChildProcess>

与 child_process.exec() 类似，除了默认不衍生 shell。 可执行的 file 会被直接衍生为一个新进程，这使得它比 child_process.exec() 更高效。

因为没有衍生 shell，所以不支持 I/O 重定向或文件查找等功能。

const { execFile } = require('child_process');
const child = execFile('node', ['--version'], (error, stdout, stderr) => {
  if (error) {
    throw error;
  }
  console.log(stdout);
});

传给 callback 的 stdout 和 stderr 包含子进程的输出。 默认情况下，Node.js 会将输出解码成 UTF-8 字符串。 encoding 用于指定解码 stdout 和 stderr 的字符编码。 如果 encoding 是 'buffer' 或无效的字符编码，则传入 callback 的会是 Buffer。

如果调用此方法的 util.promisify() 版本，则返回的 Promise 会返回具有 stdout 属性和 stderr 属性的对象。

const util = require('util');
const execFile = util.promisify(require('child_process').execFile);
async function getVersion() {
  const { stdout } = await execFile('node', ['--version']);
  console.log(stdout);
}
getVersion();

• file <string> The name or path of the executable file to run.
• args <string[]> List of string arguments.

• options <Object>

  • cwd <string> Current working directory of the child process.
  • env <Object> Environment key-value pairs.
  • encoding <string> Default: 'utf8'
  • timeout <number> Default: 0
  • maxBuffer <number> Largest amount of data in bytes allowed on stdout or stderr. If exceeded, the child process is terminated. See caveat at maxBuffer and Unicode. Default: 200 * 1024.
  • killSignal <string> | <integer> Default: 'SIGTERM'
  • uid <number> Sets the user identity of the process (see setuid(2)).
  • gid <number> Sets the group identity of the process (see setgid(2)).
  • windowsHide <boolean> Hide the subprocess console window that would normally be created on Windows systems. Default: false.
  • windowsVerbatimArguments <boolean> No quoting or escaping of arguments is done on Windows. Ignored on Unix. Default: false.
  • shell <boolean> | <string> If true, runs command inside of a shell. Uses '/bin/sh' on UNIX, and process.env.ComSpec on Windows. A different shell can be specified as a string. See Shell Requirements and Default Windows Shell. Default: false (no shell).

• callback <Function> Called with the output when process terminates.

  • error <Error>
  • stdout <string> | <Buffer>
  • stderr <string> | <Buffer>
• Returns: <ChildProcess>

The child_process.execFile() function is similar to child_process.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 child_process.exec().

The same options as child_process.exec() are supported. Since a shell is not spawned, behaviors such as I/O redirection and file globbing are not supported.

const { execFile } = require('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. 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 an additional two properties stdout and stderr.

const util = require('util');
const execFile = util.promisify(require('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.