# @types/shell-escape

> TypeScript definitions for shell-escape

Latest version **0.2.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/shell-escape
pnpm add @types/shell-escape
yarn add @types/shell-escape
bun add @types/shell-escape
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2023-11-07 |
| First published | 2017-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/shell-escape
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shell-escape
- npm.io page: https://npm.io/package/@types/shell-escape

## Recent versions

- 0.2.3 (latest) — 2023-11-07
- 0.2.1 (ts4.0) — 2022-08-24
- 0.2.0 (ts2.2) — 2017-08-31
- 0.2.2 — 2023-10-18

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shell-escape/index.d.ts)
````ts
/**
 * 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: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: none

# Credits
These definitions were written by [Miloslav Nenadál](https://github.com/nenadalm), and [BendingBender](https://github.com/BendingBender).

---
_Source: https://npm.io/package/@types/shell-escape · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._