Network Printer Manager

    @types/shell-quote
    TypeScript icon, indicating that this package has built-in type declarations

    1.7.1 • Public • Published

    Installation

    npm install --save @types/shell-quote

    Summary

    This package contains type definitions for shell-quote (https://github.com/substack/node-shell-quote).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shell-quote.

    index.d.ts

    // Type definitions for shell-quote 1.7
    // Project: https://github.com/substack/node-shell-quote
    // Definitions by: Jason Cheatham <https://github.com/jason0x43>
    //                 Cameron Diver <https://github.com/CameronDiver>
    //                 Opportunity Liu <https://github.com/OpportunityLiu>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    // TypeScript Version: 2.2
    
    export type ControlOperator = '||' | '&&' | ';;' | '|&' | '<(' | '>>' | '>&' | '&' | ';' | '(' | ')' | '|' | '<' | '>';
    
    export type ParseEntry =
        | string
        | { op: ControlOperator }
        | { op: 'glob'; pattern: string }
        | { comment: string };
    
    export interface ParseOptions {
        /**
         * Custom escape character, default value is `\`
         */
        escape?: string | undefined;
    }
    
    /**
     * Return a quoted string for the array `args` suitable for using in shell commands.
     */
    export function quote(args: ReadonlyArray<string>): string;
    
    /**
     * 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 `""`.
     */
    export function parse(
        cmd: string,
        env?: { readonly [key: string]: string | undefined },
        opts?: ParseOptions,
    ): 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 `""`.
     *
     * @param 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.
     */
    export function parse<T extends object | string>(
        cmd: string,
        env: (key: string) => T | undefined,
        opts?: ParseOptions,
    ): Array<ParseEntry | T>;

    Additional Details

    • Last updated: Tue, 06 Jul 2021 16:34:42 GMT
    • Dependencies: none
    • Global values: none

    Credits

    These definitions were written by Jason Cheatham, Cameron Diver, and Opportunity Liu.

    Keywords

    none

    Install

    npm i @types/shell-quote

    DownloadsWeekly Downloads

    50,931

    Version

    1.7.1

    License

    MIT

    Unpacked Size

    6.91 kB

    Total Files

    4

    Last publish

    Collaborators

    • types