Execa

These are functions having to do with running commands in a Bash-like TypeScript script. They are based upon the $ function from “execa”.

Variables

$

const $: ExecaScriptMethod<{
  stderr: "inherit";
  stdout: "inherit";
}>;

Defined in: functions/execa.ts:22

Run a command using the “execa” library.

This is a wrapper around the $ function from execa that sets stdout and stderr to “inherit”, resulting in it being passed through to the console. (By default, the “$” function only inherits the stdin.) This emulates the default behavior of a Bash script.

Allow Empty Variadic

See

• https://github.com/sindresorhus/execa/blob/main/docs/scripts.md
• https://nodejs.org/api/child_process.html#child_process_options_stdio

---

$q

const $q: ExecaScriptMethod<{}> = dollarSignFunc;

Defined in: functions/execa.ts:50

Run a command using the “execa” library. The “q” is short for “quiet”, meaning that the stdout will not be passed to the console.

This is a wrapper around the $ function from execa. (The quiet behavior is how the vanilla version of the $ function works, so this is just a wrapper with no additional modifications.)

Functions

$o()

function $o(templates, ...expressions): Promise<string>;

Defined in: functions/execa.ts:33

Run a command using the “execa” library and return its stdout as a string. The stdin will not be returned.

This is a wrapper around the $ function from execa.

Parameters

Parameter	Type
templates	TemplateStringsArray
…expressions	readonly TemplateExpression[]

Returns

Promise<string>