Type aliases

Command

Ƭ Command: string | [string, string[]]

Defined in types/index.ts:60

Type for providing CLI command. It may either

  • a string to store executable name without arguments.
  • an array with two elements, whose first element is executable name, and second element is array of arguments to pass to executable.

Example

const bin = "tsc";
const binWithArgs = ["tsc", ["--strict", "--target", "ESNext"]];

ExecaCommandSync

Ƭ ExecaCommandSync: Command | [string, string[], SyncOptions] | [string, string[], SyncOptions<null>] | [string, SyncOptions] | [string, SyncOptions<null>]

Defined in types/index.ts:44

Type for providing CLI command to pass to execa. It may either

  • a string to store executable name without arguments.
  • an array with two elements, whose first element is executable name, and second element is either array of arguments to pass to executable or options to pass to execa.
  • an array with three elements, whose first element is executable name, second element is array of arguments to pass to executable and third element is options to pass to execa.

Example

const bin = "tsc";
const binWithArgs = ["tsc", ["--strict", "--target", "ESNext"]];
const binWithOptions = ["tsc", { encoding: "utf-8" }];
const binWithAll = ["tsc", ["--strict", "--target", "ESNext"], { encoding: "utf-8" }];

FileFormat

Ƭ FileFormat: "json" | "yaml"

Defined in types/index.ts:89

Supported file formats for parsing and data files.


JSONData

Ƭ JSONData: Primitive | JSONObject | JSONArray

Defined in types/index.ts:26

Data type which represents JSON Data.


ParallelCommands

Ƭ ParallelCommands: Record<string, Command | null | undefined>

Defined in types/index.ts:70

Array of CLI commands to execute concurrently in parallel.


SerialCommands

Ƭ SerialCommands: string | [string, string[]] | [string, string[], SyncOptions<string>] | [string, string[], SyncOptions<null>] | [string, SyncOptions<string>] | [string, SyncOptions<null>] | object[]

Defined in types/index.ts:65

Array of CLI commands to execute serially.

Functions

getFilteredArray

getFilteredArray(array: string[], __namedParameters: object): string[]

Defined in util.ts:189

Filters an array based on starting strings of its elements and returns filtered array as a new array.

Parameters:

array: string[]

is array to be filtered.

__namedParameters: object

Name Type Default Description
exclude string | string[] [] is string or array of strings, of which elements starting with is excluded.
include string | string[] [] is string or array of strings, of which elements starting with is included.

Returns: string[]

filtered array.