@types/shell-escape

Installation

npm install --save @types/shell-escape

Summary

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

Details

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

index.d.ts

// Type definitions for shell-escape 0.2
// Project: https://github.com/xxorax/node-shell-escape
// Definitions by: Miloslav Nenadál <https://github.com/nenadalm>
//                 BendingBender <https://github.com/BendingBender>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * Escape and stringify an array of arguments to be executed on the shell.
 *
 * @example
 * import shellescape = require('shell-escape');
 *
 * const simpleArgs = ['curl', '-H', 'Location;', '-H', 'User-Agent: dave#10', 'https://example.com?foo=bar&baz=quux'];
 * console.log(shellescape(simpleArgs));
 * // => curl -H 'Location;' -H 'User-Agent: dave#10' 'https://example.com?foo=bar&baz=quux'
 *
 * const advancedArgs = ['echo', 'hello!', 'how are you doing $USER', '"double"', "'single'"];
 * console.log(shellescape(advancedArgs));
 * // => echo 'hello!' 'how are you doing $USER' '"double"' \''single'\'
 */
declare function shellEscape(args: readonly string[]): string;

export = shellEscape;

Additional Details

• Last updated: Wed, 24 Aug 2022 08:32:19 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Miloslav Nenadál, and BendingBender.