execa
- Version 8.0.1
- Published
- 80.1 kB
- 9 dependencies
- MIT license
Install
npm i execa
yarn add execa
pnpm add execa
Overview
Process execution for humans
Index
Variables
Functions
Type Aliases
Variables
variable $
const $: Execa$<string>;
Executes a command. The
command
string includes both thefile
and itsarguments
. Returns achildProcess
.Arguments are automatically escaped. They can contain any character, but spaces must use
${}
like `` $echo ${'has space'}
``.This is the preferred method when executing multiple commands in a script file.
The
command
string can inject any${value}
with the following types: string, number,childProcess
or an array of those types. For example: `` $echo one ${'two'} ${3} ${['four', 'five']}
``. For${childProcess}
, the process'sstdout
is used.Returns
An
ExecaChildProcess
that is both: - aPromise
resolving or rejecting with achildProcessResult
. - a [child_process
instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess) with some additional methods and properties.Throws
A
childProcessResult
errorExample 1
Basic
import {$} from 'execa';const branch = await $`git branch --show-current`;await $`dep deploy --branch=${branch}`;Example 2
Multiple arguments
import {$} from 'execa';const args = ['unicorns', '&', 'rainbows!'];const {stdout} = await $`echo ${args}`;console.log(stdout);//=> 'unicorns & rainbows!'Example 3
With options
import {$} from 'execa';await $({stdio: 'inherit'})`echo unicorns`;//=> 'unicorns'Example 4
Shared options
import {$} from 'execa';const $$ = $({stdio: 'inherit'});await $$`echo unicorns`;//=> 'unicorns'await $$`echo rainbows`;//=> 'rainbows'
Functions
function execa
execa: { ( file: string, arguments?: readonly string[], options?: Options ): ExecaChildProcess; (file: string, arguments?: readonly string[], options?: Options<'buffer'>): any; (file: string, options?: Options<'utf8'>): any; (file: string, options?: Options<'buffer'>): any;};
Executes a command using
file ...arguments
.arguments
are specified as an array of strings. Returns achildProcess
.Arguments are automatically escaped. They can contain any character, including spaces.
This is the preferred method when executing single commands.
Parameter file
The program/script to execute.
Parameter arguments
Arguments to pass to
file
on execution.Returns
An
ExecaChildProcess
that is both: - aPromise
resolving or rejecting with achildProcessResult
. - a [child_process
instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess) with some additional methods and properties.Throws
A
childProcessResult
errorExample 1
Promise interface
import {execa} from 'execa';const {stdout} = await execa('echo', ['unicorns']);console.log(stdout);//=> 'unicorns'Example 2
Redirect output to a file
import {execa} from 'execa';// Similar to `echo unicorns > stdout.txt` in Bashawait execa('echo', ['unicorns']).pipeStdout('stdout.txt');// Similar to `echo unicorns 2> stdout.txt` in Bashawait execa('echo', ['unicorns']).pipeStderr('stderr.txt');// Similar to `echo unicorns &> stdout.txt` in Bashawait execa('echo', ['unicorns'], {all: true}).pipeAll('all.txt');Example 3
Redirect input from a file
import {execa} from 'execa';// Similar to `cat < stdin.txt` in Bashconst {stdout} = await execa('cat', {inputFile: 'stdin.txt'});console.log(stdout);//=> 'unicorns'Example 4
Save and pipe output from a child process
import {execa} from 'execa';const {stdout} = await execa('echo', ['unicorns']).pipeStdout(process.stdout);// Prints `unicorns`console.log(stdout);// Also returns 'unicorns'Example 5
Pipe multiple processes
import {execa} from 'execa';// Similar to `echo unicorns | cat` in Bashconst {stdout} = await execa('echo', ['unicorns']).pipeStdout(execa('cat'));console.log(stdout);//=> 'unicorns'Example 6
Handling errors
import {execa} from 'execa';// Catching an errortry {await execa('unknown', ['command']);} catch (error) {console.log(error);/*{message: 'Command failed with ENOENT: unknown command spawn unknown ENOENT',errno: -2,code: 'ENOENT',syscall: 'spawn unknown',path: 'unknown',spawnargs: ['command'],originalMessage: 'spawn unknown ENOENT',shortMessage: 'Command failed with ENOENT: unknown command spawn unknown ENOENT',command: 'unknown command',escapedCommand: 'unknown command',stdout: '',stderr: '',failed: true,timedOut: false,isCanceled: false,killed: false,cwd: '/path/to/cwd'}\*\/}Example 7
Graceful termination
const subprocess = execa('node');setTimeout(() => {subprocess.kill('SIGTERM', {forceKillAfterTimeout: 2000});}, 1000);
function execaCommand
execaCommand: { (command: string, options?: Options): ExecaChildProcess; (command: string, options?: Options<'buffer'>): any;};
Executes a command. The
command
string includes both thefile
and itsarguments
. Returns achildProcess
.Arguments are automatically escaped. They can contain any character, but spaces must be escaped with a backslash like
execaCommand('echo has\\ space')
.This is the preferred method when executing a user-supplied
command
string, such as in a REPL.Parameter command
The program/script to execute and its arguments.
Returns
An
ExecaChildProcess
that is both: - aPromise
resolving or rejecting with achildProcessResult
. - a [child_process
instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess) with some additional methods and properties.Throws
A
childProcessResult
errorExample 1
import {execaCommand} from 'execa';const {stdout} = await execaCommand('echo unicorns');console.log(stdout);//=> 'unicorns'
function execaCommandSync
execaCommandSync: { (command: string, options?: SyncOptions): ExecaSyncReturnValue; (command: string, options?: SyncOptions<'buffer'>): ExecaReturnBase<Buffer>;};
Same as
execaCommand()
but synchronous.Parameter command
The program/script to execute and its arguments.
Returns
A
childProcessResult
objectThrows
A
childProcessResult
errorExample 1
import {execaCommandSync} from 'execa';const {stdout} = execaCommandSync('echo unicorns');console.log(stdout);//=> 'unicorns'
function execaNode
execaNode: { ( scriptPath: string, arguments?: readonly string[], options?: NodeOptions ): ExecaChildProcess; ( scriptPath: string, arguments?: readonly string[], options?: NodeOptions<'buffer'> ): any; (scriptPath: string, options?: NodeOptions<'utf8'>): any; (scriptPath: string, options?: NodeOptions<'buffer'>): any;};
Execute a Node.js script as a child process.
Arguments are automatically escaped. They can contain any character, including spaces.
This is the preferred method when executing Node.js files.
Like [
child_process#fork()
](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options): - the current Node version and options are used. This can be overridden using thenodePath
andnodeOptions
options. - theshell
option cannot be used - an extra channel [ipc
](https://nodejs.org/api/child_process.html#child_process_options_stdio) is passed tostdio
Parameter scriptPath
Node.js script to execute.
Parameter arguments
Arguments to pass to
scriptPath
on execution.Returns
An
ExecaChildProcess
that is both: - aPromise
resolving or rejecting with achildProcessResult
. - a [child_process
instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess) with some additional methods and properties.Throws
A
childProcessResult
errorExample 1
import {execa} from 'execa';await execaNode('scriptPath', ['argument']);
function execaSync
execaSync: { ( file: string, arguments?: readonly string[], options?: SyncOptions ): ExecaSyncReturnValue; ( file: string, arguments?: readonly string[], options?: SyncOptions<'buffer'> ): ExecaReturnBase<Buffer>; (file: string, options?: SyncOptions<'utf8'>): ExecaReturnBase<string>; (file: string, options?: SyncOptions<'buffer'>): ExecaReturnBase<Buffer>;};
Same as
execa()
but synchronous.Parameter file
The program/script to execute.
Parameter arguments
Arguments to pass to
file
on execution.Returns
A
childProcessResult
objectThrows
A
childProcessResult
errorExample 1
Promise interface
import {execa} from 'execa';const {stdout} = execaSync('echo', ['unicorns']);console.log(stdout);//=> 'unicorns'Example 2
Redirect input from a file
import {execa} from 'execa';// Similar to `cat < stdin.txt` in Bashconst {stdout} = execaSync('cat', {inputFile: 'stdin.txt'});console.log(stdout);//=> 'unicorns'Example 3
Handling errors
import {execa} from 'execa';// Catching an errortry {execaSync('unknown', ['command']);} catch (error) {console.log(error);/*{message: 'Command failed with ENOENT: unknown command spawnSync unknown ENOENT',errno: -2,code: 'ENOENT',syscall: 'spawnSync unknown',path: 'unknown',spawnargs: ['command'],originalMessage: 'spawnSync unknown ENOENT',shortMessage: 'Command failed with ENOENT: unknown command spawnSync unknown ENOENT',command: 'unknown command',escapedCommand: 'unknown command',stdout: '',stderr: '',failed: true,timedOut: false,isCanceled: false,killed: false,cwd: '/path/to/cwd'}\*\/}
Type Aliases
type BufferEncodingOption
type BufferEncodingOption = 'buffer' | null;
type CommonOptions
type CommonOptions<EncodingType extends EncodingOption = DefaultEncodingOption> = { /** Kill the spawned process when the parent process exits unless either: - the spawned process is [`detached`](https://nodejs.org/api/child_process.html#child_process_options_detached) - the parent process is terminated abruptly, for example, with `SIGKILL` as opposed to `SIGTERM` or a normal exit
@default true */ readonly cleanup?: boolean;
/** Prefer locally installed binaries when looking for a binary to execute.
If you `$ npm install foo`, you can then `execa('foo')`.
@default `true` with `$`, `false` otherwise */ readonly preferLocal?: boolean;
/** Preferred path to find locally installed binaries in (use with `preferLocal`).
@default process.cwd() */ readonly localDir?: string | URL;
/** 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.
@default process.execPath */ readonly execPath?: string;
/** 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.
@default true */ readonly buffer?: boolean;
/** Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
@default `inherit` with `$`, `pipe` otherwise */ readonly stdin?: StdioOption;
/** Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
@default 'pipe' */ readonly stdout?: StdioOption;
/** Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio).
@default 'pipe' */ readonly stderr?: StdioOption;
/** Setting this to `false` resolves the promise with the error instead of rejecting it.
@default true */ readonly reject?: boolean;
/** Add an `.all` property on the promise and the resolved value. The property contains the output of the process with `stdout` and `stderr` interleaved.
@default false */ readonly all?: boolean;
/** Strip the final [newline character](https://en.wikipedia.org/wiki/Newline) from the output.
@default true */ readonly stripFinalNewline?: boolean;
/** Set to `false` if you don't want to extend the environment variables when providing the `env` property.
@default true */ readonly extendEnv?: boolean;
/** Current working directory of the child process.
@default process.cwd() */ readonly cwd?: string | URL;
/** Environment key-value pairs. Extends automatically from `process.env`. Set `extendEnv` to `false` if you don't want this.
@default process.env */ readonly env?: NodeJS.ProcessEnv;
/** Explicitly set the value of `argv[0]` sent to the child process. This will be set to `command` or `file` if not specified. */ readonly argv0?: string;
/** Child's [stdio](https://nodejs.org/api/child_process.html#child_process_options_stdio) configuration.
@default 'pipe' */ readonly stdio?: | 'pipe' | 'overlapped' | 'ignore' | 'inherit' | readonly StdioOption[];
/** Specify the kind of serialization used for sending messages between processes when using the `stdio: 'ipc'` option or `execaNode()`: - `json`: Uses `JSON.stringify()` and `JSON.parse()`. - `advanced`: Uses [`v8.serialize()`](https://nodejs.org/api/v8.html#v8_v8_serialize_value)
[More info.](https://nodejs.org/api/child_process.html#child_process_advanced_serialization)
@default 'json' */ readonly serialization?: 'json' | 'advanced';
/** Prepare child to run independently of its parent process. Specific behavior [depends on the platform](https://nodejs.org/api/child_process.html#child_process_options_detached).
@default false */ readonly detached?: boolean;
/** Sets the user identity of the process. */ readonly uid?: number;
/** Sets the group identity of the process. */ readonly gid?: number;
/** 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.
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.
@default false */ readonly shell?: boolean | string;
/** Specify the character encoding used to decode the `stdout` and `stderr` output. If set to `'buffer'` or `null`, then `stdout` and `stderr` will be a `Buffer` instead of a string.
@default 'utf8' */ readonly encoding?: EncodingType;
/** 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.
@default 0 */ readonly timeout?: number;
/** Largest amount of data in bytes allowed on `stdout` or `stderr`. Default: 100 MB.
@default 100_000_000 */ readonly maxBuffer?: number;
/** Signal value to be used when the spawned process will be killed.
@default 'SIGTERM' */ readonly killSignal?: string | number;
/** You can abort the spawned process using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
When `AbortController.abort()` is called, [`.isCanceled`](https://github.com/sindresorhus/execa#iscanceled) becomes `true`.
@example ``` import {execa} from 'execa';
const abortController = new AbortController(); const subprocess = execa('node', [], {signal: abortController.signal});
setTimeout(() => { abortController.abort(); }, 1000);
try { await subprocess; } catch (error) { console.log(subprocess.killed); // true console.log(error.isCanceled); // true } ``` */ readonly signal?: AbortSignal;
/** 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`.
@default false */ readonly windowsVerbatimArguments?: boolean;
/** On Windows, do not create a new console window. Please note this also prevents `CTRL-C` [from working](https://github.com/nodejs/node/issues/29837) on Windows.
@default true */ readonly windowsHide?: boolean;
/** Print each command on `stderr` before executing it.
This can also be enabled by setting the `NODE_DEBUG=execa` environment variable in the current process.
@default false */ readonly verbose?: boolean;};
type DefaultEncodingOption
type DefaultEncodingOption = 'utf8';
type EncodingOption
type EncodingOption = | 'utf8' // eslint-disable-next-line unicorn/text-encoding-identifier-case | 'utf-8' | 'utf16le' | 'utf-16le' | 'ucs2' | 'ucs-2' | 'latin1' | 'binary' | 'ascii' | 'hex' | 'base64' | 'base64url' | 'buffer' | null | undefined;
type Execa$
type Execa$<StdoutStderrType extends StdoutStderrAll = string> = { /** Returns a new instance of `$` but with different default `options`. Consecutive calls are merged to previous ones.
This can be used to either: - Set options for a specific command: `` $(options)`command` `` - Share options for multiple commands: `` const $$ = $(options); $$`command`; $$`otherCommand` ``
@param options - Options to set @returns A new instance of `$` with those `options` set
@example ``` import {$} from 'execa';
const $$ = $({stdio: 'inherit'});
await $$`echo unicorns`; //=> 'unicorns'
await $$`echo rainbows`; //=> 'rainbows' ``` */ (options: Options<undefined>): Execa$<StdoutStderrType>; (options: Options): Execa$; (options: Options<BufferEncodingOption>): Execa$<Buffer>; ( templates: TemplateStringsArray, ...expressions: TemplateExpression[] ): ExecaChildProcess<StdoutStderrType>;
/** Same as $\`command\` but synchronous.
@returns A `childProcessResult` object @throws A `childProcessResult` error
@example <caption>Basic</caption> ``` import {$} from 'execa';
const branch = $.sync`git branch --show-current`; $.sync`dep deploy --branch=${branch}`; ```
@example <caption>Multiple arguments</caption> ``` import {$} from 'execa';
const args = ['unicorns', '&', 'rainbows!']; const {stdout} = $.sync`echo ${args}`; console.log(stdout); //=> 'unicorns & rainbows!' ```
@example <caption>With options</caption> ``` import {$} from 'execa';
$.sync({stdio: 'inherit'})`echo unicorns`; //=> 'unicorns' ```
@example <caption>Shared options</caption> ``` import {$} from 'execa';
const $$ = $({stdio: 'inherit'});
$$.sync`echo unicorns`; //=> 'unicorns'
$$.sync`echo rainbows`; //=> 'rainbows' ``` */ sync( templates: TemplateStringsArray, ...expressions: TemplateExpression[] ): ExecaSyncReturnValue<StdoutStderrType>;};
type ExecaChildProcess
type ExecaChildProcess<StdoutStderrType extends StdoutStderrAll = string> = ChildProcess & ExecaChildPromise<StdoutStderrType> & Promise<ExecaReturnValue<StdoutStderrType>>;
type ExecaChildPromise
type ExecaChildPromise<StdoutStderrType extends StdoutStderrAll> = { /** Stream combining/interleaving [`stdout`](https://nodejs.org/api/child_process.html#child_process_subprocess_stdout) and [`stderr`](https://nodejs.org/api/child_process.html#child_process_subprocess_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) */ all?: ReadableStream;
catch<ResultType = never>( onRejected?: ( reason: ExecaError<StdoutStderrType> ) => ResultType | PromiseLike<ResultType> ): Promise<ExecaReturnValue<StdoutStderrType> | ResultType>;
/** Same as the original [`child_process#kill()`](https://nodejs.org/api/child_process.html#child_process_subprocess_kill_signal), except if `signal` is `SIGTERM` (the default value) and the child process is not terminated after 5 seconds, force it by sending `SIGKILL`. Note that this graceful termination does not work on Windows, because Windows [doesn't support signals](https://nodejs.org/api/process.html#process_signal_events) (`SIGKILL` and `SIGTERM` has the same effect of force-killing the process immediately.) If you want to achieve graceful termination on Windows, you have to use other means, such as [`taskkill`](https://github.com/sindresorhus/taskkill). */ kill(signal?: string, options?: KillOptions): void;
/** Similar to [`childProcess.kill()`](https://nodejs.org/api/child_process.html#child_process_subprocess_kill_signal). This used to be preferred when cancelling the child process execution as the error is more descriptive and [`childProcessResult.isCanceled`](#iscanceled) is set to `true`. But now this is deprecated and you should either use `.kill()` or the `signal` option when creating the child process. */ cancel(): void;
/** [Pipe](https://nodejs.org/api/stream.html#readablepipedestination-options) the child process's `stdout` to `target`, which can be: - Another `execa()` return value - A writable stream - A file path string
If the `target` is another `execa()` return value, it is returned. Otherwise, the original `execa()` return value is returned. This allows chaining `pipeStdout()` then `await`ing the final result.
The `stdout` option] must be kept as `pipe`, its default value. */ pipeStdout?<Target extends ExecaChildPromise<StdoutStderrAll>>( target: Target ): Target; pipeStdout?( target: WritableStream | string ): ExecaChildProcess<StdoutStderrType>;
/** Like `pipeStdout()` but piping the child process's `stderr` instead.
The `stderr` option must be kept as `pipe`, its default value. */ pipeStderr?<Target extends ExecaChildPromise<StdoutStderrAll>>( target: Target ): Target; pipeStderr?( target: WritableStream | string ): ExecaChildProcess<StdoutStderrType>;
/** Combines both `pipeStdout()` and `pipeStderr()`.
Either the `stdout` option or the `stderr` option must be kept as `pipe`, their default value. Also, the `all` option must be set to `true`. */ pipeAll?<Target extends ExecaChildPromise<StdoutStderrAll>>( target: Target ): Target; pipeAll?(target: WritableStream | string): ExecaChildProcess<StdoutStderrType>;};
type ExecaError
type ExecaError<StdoutStderrType extends StdoutStderrAll = string> = { /** The output of the process with `stdout` and `stderr` interleaved.
This is `undefined` if either: - the `all` option is `false` (default value) - `execaSync()` was used */ all?: StdoutStderrType;
/** Whether the process was canceled. */ isCanceled: boolean;} & ExecaSyncError<StdoutStderrType>;
type ExecaReturnBase
type ExecaReturnBase<StdoutStderrType extends StdoutStderrAll> = { /** 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 `execaCommand()`. */ command: string;
/** 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 `execaCommand()`. */ escapedCommand: string;
/** The numeric exit code of the process that was run. */ exitCode: number;
/** The output of the process on stdout. */ stdout: StdoutStderrType;
/** The output of the process on stderr. */ stderr: StdoutStderrType;
/** Whether the process failed to run. */ failed: boolean;
/** Whether the process timed out. */ timedOut: boolean;
/** Whether the process was killed. */ killed: boolean;
/** 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`. */ signal?: string;
/** A human-friendly description of the signal that was used to terminate the process. For example, `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. */ signalDescription?: string;
/** The `cwd` of the command if provided in the command options. Otherwise it is `process.cwd()`. */ cwd: string;};
type ExecaReturnValue
type ExecaReturnValue<StdoutStderrType extends StdoutStderrAll = string> = { /** The output of the process with `stdout` and `stderr` interleaved.
This is `undefined` if either: - the `all` option is `false` (default value) - `execaSync()` was used */ all?: StdoutStderrType;
/** Whether the process was canceled.
You can cancel the spawned process using the [`signal`](https://github.com/sindresorhus/execa#signal-1) option. */ isCanceled: boolean;} & ExecaSyncReturnValue<StdoutStderrType>;
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
type ExecaSyncError
type ExecaSyncError<StdoutStderrType extends StdoutStderrAll = string> = { /** 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. */ message: string;
/** This is the same as the `message` property except it does not include the child process stdout/stderr. */ shortMessage: string;
/** 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. */ originalMessage?: string;} & Error & ExecaReturnBase<StdoutStderrType>;
type ExecaSyncReturnValue
type ExecaSyncReturnValue<StdoutStderrType extends StdoutStderrAll = string> = {} & ExecaReturnBase<StdoutStderrType>;
type KillOptions
type KillOptions = { /** Milliseconds to wait for the child process to terminate before sending `SIGKILL`.
Can be disabled with `false`.
@default 5000 */ forceKillAfterTimeout?: number | false;};
type NodeOptions
type NodeOptions<EncodingType extends EncodingOption = DefaultEncodingOption> = { /** The Node.js executable to use.
@default process.execPath */ readonly nodePath?: string;
/** List of [CLI options](https://nodejs.org/api/cli.html#cli_options) passed to the Node.js executable.
@default process.execArgv */ readonly nodeOptions?: string[];} & Options<EncodingType>;
type Options
type Options<EncodingType extends EncodingOption = DefaultEncodingOption> = { /** Write some input to the `stdin` of your binary.
If the input is a file, use the `inputFile` option instead. */ readonly input?: string | Buffer | ReadableStream;
/** Use a file as input to the the `stdin` of your binary.
If the input is not a file, use the `input` option instead. */ readonly inputFile?: string;} & CommonOptions<EncodingType>;
type StdioOption
type StdioOption = | 'pipe' | 'overlapped' | 'ipc' | 'ignore' | 'inherit' | Stream | number | undefined;
type StdoutStderrAll
type StdoutStderrAll = string | Buffer | undefined;
type SyncOptions
type SyncOptions<EncodingType extends EncodingOption = DefaultEncodingOption> = { /** Write some input to the `stdin` of your binary.
If the input is a file, use the `inputFile` option instead. */ readonly input?: string | Buffer;
/** Use a file as input to the the `stdin` of your binary.
If the input is not a file, use the `input` option instead. */ readonly inputFile?: string;} & CommonOptions<EncodingType>;
type TemplateExpression
type TemplateExpression = | string | number | ExecaReturnValue<string | Buffer> | ExecaSyncReturnValue<string | Buffer> | Array< | string | number | ExecaReturnValue<string | Buffer> | ExecaSyncReturnValue<string | Buffer> >;
Package Files (1)
Dependencies (9)
Dev Dependencies (10)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/execa
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/execa)
- HTML<a href="https://www.jsdocs.io/package/execa"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3044 ms. - Missing or incorrect documentation? Open an issue for this package.