Kill the spawned process when the parent process exits unless either:
- the spawned process is detached
- the parent process is terminated abruptly, for example, with SIGKILL as opposed to SIGTERM or a normal exit
Prefer locally installed binaries when looking for a binary to execute.
If you `$ npm install foo`, you can then `execa('foo')`.
Preferred path to find locally installed binaries in (use with preferLocal).
Path to the Node.js executable to use in child processes.
This can be either an absolute path or a path relative to the `cwd` option.
Requires `preferLocal` to be `true`.
For example, this can be used together with [`get-node`](https://github.com/ehmicky/get-node) to run a specific Node.js version in a child process.
Buffer the output from the spawned process. When set to false, you must read the output of stdout and stderr (or all if the all option is true). Otherwise the returned promise will not be resolved/rejected.
If the spawned process fails, `error.stdout`, `error.stderr`, and `error.all` will contain the buffered data.
Same options as stdio.
Setting this to false resolves the promise with the error instead of rejecting it.
Add an .all property on the promise and the resolved value. The property contains the output of the process with stdout and stderr interleaved.
Strip the final newline character from the output.
Set to false if you don't want to extend the environment variables when providing the env property.
Current working directory of the child process.
Environment key-value pairs. Extends automatically from process.env. Set extendEnv to false if you don't want this.
Explicitly set the value of argv sent to the child process. This will be set to command or file if not specified.
Child's stdio configuration.
Specify the kind of serialization used for sending messages between processes when using the stdio: 'ipc' option or execa.node():
- json: Uses JSON.stringify() and JSON.parse().
- advanced: Uses v8.serialize()
Requires Node.js `13.2.0` or later.
Prepare child to run independently of its parent process. Specific behavior depends on the platform.
Sets the user identity of the process.
Sets the group identity of the process.
If true, runs command inside of a shell. Uses /bin/sh on UNIX and cmd.exe on Windows. A different shell can be specified as a string. The shell should understand the -c switch on UNIX or /d /s /c on Windows.
/d /s /c
We recommend against using this option since it is:
- not cross-platform, encouraging shell-specific syntax.
- slower, because of the additional shell interpretation.
- unsafe, potentially allowing command injection.
Specify the character encoding used to decode the stdout and stderr output. If set to null, then stdout and stderr will be a Buffer instead of a string.
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.
Largest amount of data in bytes allowed on stdout or stderr. Default: 100 MB.
Signal value to be used when the spawned process will be killed.
If true, no quoting or escaping of arguments is done on Windows. Ignored on other platforms. This is set to true automatically when the shell option is true.
On Windows, do not create a new console window. Please note this also prevents CTRL-C from working on Windows.
Write some input to the stdin of your binary.
The Node.js executable to use.
List of CLI options passed to the Node.js executable.
The file and arguments that were run, for logging purposes.
This is not escaped and should not be executed directly as a process, including using `execa()` or `execa.command()`.
Same as command but escaped.
This is meant to be copy and pasted into a shell, for debugging purposes.
Since the escaping is fairly basic, this should not be executed directly as a process, including using `execa()` or `execa.command()`.
The numeric exit code of the process that was run.
The output of the process on stdout.
The output of the process on stderr.
Whether the process failed to run.
Whether the process timed out.
Whether the process was killed.
The name of the signal that was used to terminate the process. For example, SIGFPE.
If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`.
A human-friendly description of the signal that was used to terminate the process. For example, Floating point arithmetic error.
Floating point arithmetic error
If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`. It is also `undefined` when the signal is very uncommon which should seldomly happen.
Result of a child process execution. On success this is a plain object. On failure this is also an Error instance.
The child process fails when:
- its exit code is not `0`
- it was killed with a signal
- timing out
- being canceled
- there's not enough memory or there are already too many child processes
The output of the process with stdout and stderr interleaved.
This is `undefined` if either:
- the `all` option is `false` (default value)
- `execa.sync()` was used
Whether the process was canceled.
Error message when the child process failed to run. In addition to the underlying error message, it also contains some information related to why the child process errored.
The child process stderr then stdout are appended to the end, separated with newlines and not interleaved.
This is the same as the message property except it does not include the child process stdout/stderr.
Original error message. This is the same as the message property except it includes neither the child process stdout/stderr nor some additional information added by Execa.
This is `undefined` unless the child process exited due to an `error` event or a timeout.
Milliseconds to wait for the child process to terminate before sending SIGKILL.
Can be disabled with `false`.
Stream combining/interleaving stdout and stderr.
This is `undefined` if either:
- the `all` option is `false` (the default value)
- both `stdout` and `stderr` options are set to [`'inherit'`, `'ipc'`, `Stream` or `integer`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio)
Same as the original child_process#kill(), except if signal is SIGTERM (the default value) and the child process is not terminated after 5 seconds, force it by sending SIGKILL.
Similar to childProcess.kill(). This is preferred when cancelling the child process execution as the error is more descriptive and childProcessResult.isCanceled is set to true.