Execa
Helper functions having to do with running commands in a Bash-like TypeScript script.
These functions are based upon the
$ function from the
execa library, but pass the stdout/stderr to the
console (which is the default behavior of a Bash script).
Functions
$()
Same as execa() but using script-friendly default options.
When command is a template string, it includes both the file and its arguments.
$(options) can be used to return a new instance of this method but with different default options. Consecutive calls are merged to previous ones.
This is the preferred method when executing multiple commands in a script file.
Throws
ExecaError
Examples
import {$} from 'execa';
const branch = await $`git branch --show-current`;
await $`dep deploy --branch=${branch}`;
$ node build.js
Building application...
Done building.
Running tests...
Error: the entrypoint is invalid.
$ NODE_DEBUG=execa node build.js
[00:57:44.581] [0] $ npm run build
[00:57:44.653] [0] Building application...
[00:57:44.653] [0] Done building.
[00:57:44.658] [0] ✔ (done in 78ms)
[00:57:44.658] [1] $ npm run test
[00:57:44.740] [1] Running tests...
[00:57:44.740] [1] Error: the entrypoint is invalid.
[00:57:44.747] [1] ✘ Command failed with exit code 1: npm run test
[00:57:44.747] [1] ✘ (done in 89ms)
Call Signature
function $<NewOptionsType>(options): ExecaScriptMethod<object & NewOptionsType>
Type Parameters
| Type Parameter | Default type |
|---|---|
NewOptionsType extends CommonOptions | object |
Parameters
| Parameter | Type |
|---|---|
options | NewOptionsType |
Returns
ExecaScriptMethod<object & NewOptionsType>
Defined in
node_modules/execa/types/methods/script.d.ts:53
Call Signature
function $(...templateString): ResultPromise<object>
Parameters
| Parameter | Type |
|---|---|
...templateString | readonly [TemplateStringsArray, TemplateExpression] |
Returns
ResultPromise<object>
Defined in
node_modules/execa/types/methods/script.d.ts:53
Call Signature
function $<NewOptionsType>(
file,
arguments?,
options?): ResultPromise<StricterOptions<object & NewOptionsType, Options>>
Type Parameters
| Type Parameter | Default type |
|---|---|
NewOptionsType extends Options | object |
Parameters
| Parameter | Type |
|---|---|
file | string | URL |
arguments? | readonly string[] |
options? | NewOptionsType |
Returns
ResultPromise<StricterOptions<object & NewOptionsType, Options>>
Defined in
node_modules/execa/types/methods/script.d.ts:53
Call Signature
function $<NewOptionsType>(file, options?): ResultPromise<StricterOptions<object & NewOptionsType, Options>>
Type Parameters
| Type Parameter | Default type |
|---|---|
NewOptionsType extends Options | object |
Parameters
| Parameter | Type |
|---|---|
file | string | URL |
options? | NewOptionsType |
Returns
ResultPromise<StricterOptions<object & NewOptionsType, Options>>
Defined in
node_modules/execa/types/methods/script.d.ts:53
$o()
function $o(templates, ...expressions): string
Helper function to run a command and grab the output. ("o" is short for "output".)
If an error occurs, the full JavaScript stack trace will be printed. Alternatively, if you expect this command to return a non-zero exit code, you can enclose this function in a try/catch block.
This is a wrapper around the $.sync function from execa. (The $.sync function automatically
trims the stdout.)
Parameters
| Parameter | Type |
|---|---|
templates | TemplateStringsArray |
...expressions | readonly TemplateExpression[] |
Returns
string
Defined in
packages/complete-node/src/functions/execa.ts:28
$q()
function $q(templates, ...expressions): Promise<Result>
A wrapper around the $ function from execa. ("q" is short for "quiet".) This is the same
thing as the $ helper function, except the stdout/stderr is not passed through to the console.
If an error occurs, the full JavaScript stack trace will be printed. Alternatively, if you expect this command to return a non-zero exit code, you can enclose this function in a try/catch block.
Parameters
| Parameter | Type |
|---|---|
templates | TemplateStringsArray |
...expressions | readonly TemplateExpression[] |
Returns
Promise<Result>
Defined in
packages/complete-node/src/functions/execa.ts:42
$s()
function $s(templates, ...expressions): Result
Alias for the $.sync function from execa.
Parameters
| Parameter | Type |
|---|---|
templates | TemplateStringsArray |
...expressions | readonly TemplateExpression[] |
Returns
Result
Defined in
packages/complete-node/src/functions/execa.ts:53
$sq()
function $sq(templates, ...expressions): Result
A wrapper around the $.sync function from execa. ("sq" is short for "sync quiet".) This is
the same thing as the $s helper function, except the stdout/stderr is not passed through to the
console.
If an error occurs, the full JavaScript stack trace will be printed. Alternatively, if you expect this command to return a non-zero exit code, you can enclose this function in a try/catch block.
Parameters
| Parameter | Type |
|---|---|
templates | TemplateStringsArray |
...expressions | readonly TemplateExpression[] |
Returns
Result