@types/shell-quote

Functions

• parse()
• quote()

Interfaces

• ParseOptions

  • escape

Type Aliases

• ControlOperator
• ParseEntry

function parse

parse: {
    (
        cmd: string,
        env?: { readonly [key: string]: string },
        opts?: ParseOptions
    ): ParseEntry[];
    <T extends string | object>(
        cmd: string,
        env: (key: string) => T,
        opts?: ParseOptions
    ): (T | ParseEntry)[];
};

• Return an array of arguments from the quoted string cmd.

  Interpolate embedded bash-style $VARNAME and ${VARNAME} variables with the env object which like bash will replace undefined variables with "".

• Return an array of arguments from the quoted string cmd.

  Interpolate embedded bash-style $VARNAME and ${VARNAME} variables with the env object which like bash will replace undefined variables with "".

  Parameter env

  A function to perform lookups. When env(key) returns a string, its result will be output just like env[key] would. When env(key) returns an object, it will be inserted into the result array like the operator objects.

function quote

quote: (args: readonly string[]) => string;

• Return a quoted string for the array args suitable for using in shell commands.

type ControlOperator

type ControlOperator =
    | '||'
    | '&&'
    | ';;'
    | '|&'
    | '<('
    | '>>'
    | '>&'
    | '&'
    | ';'
    | '('
    | ')'
    | '|'
    | '<'
    | '>';

type ParseEntry

type ParseEntry =
    | string
    | { op: ControlOperator }
    | { op: 'glob'; pattern: string }
    | { comment: string };