Optional ReadonlyallOptional Readonlyargv0Explicitly set the value of argv[0] sent to the child process. This will be set to command or file if not specified.
Optional ReadonlybufferBuffer 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.
Optional ReadonlycleanupKill 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
Optional ReadonlycwdCurrent working directory of the child process.
Optional ReadonlydetachedPrepare child to run independently of its parent process. Specific behavior depends on the platform.
Optional ReadonlyencodingSpecify 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.
Optional ReadonlyenvEnvironment key-value pairs. Extends automatically from process.env. Set extendEnv to false if you don't want this.
Optional ReadonlyexecPath 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 to run a specific Node.js version in a child process.
Optional ReadonlyextendSet to false if you don't want to extend the environment variables when providing the env property.
Optional ReadonlygidSets the group identity of the process.
Optional ReadonlykillSignal value to be used when the spawned process will be killed.
Optional ReadonlylocalPreferred path to find locally installed binaries in (use with preferLocal).
Optional ReadonlymaxLargest amount of data in bytes allowed on stdout or stderr. Default: 100 MB.
Optional ReadonlypreferPrefer locally installed binaries when looking for a binary to execute.
If you $ npm install foo, you can then execa('foo').
Optional ReadonlyrejectSetting this to false resolves the promise with the error instead of rejecting it.
Optional ReadonlyserializationSpecify 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.
Optional ReadonlyshellIf 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.
We recommend against using this option since it is:
Optional ReadonlystderrSame options as stdio.
Optional ReadonlystdinSame options as stdio.
Optional ReadonlystdioChild's stdio configuration.
Optional ReadonlystdoutSame options as stdio.
Optional ReadonlystripStrip the final newline character from the output.
Optional ReadonlytimeoutIf 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.
Optional ReadonlyuidSets the user identity of the process.
Optional ReadonlywindowsOn Windows, do not create a new console window. Please note this also prevents CTRL-C from working on Windows.
Optional ReadonlywindowsIf 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.
Add an
.allproperty on the promise and the resolved value. The property contains the output of the process withstdoutandstderrinterleaved.