Installations

npm install @types/shell-quote

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Score

100

Supply Chain

85.5

Quality

75.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

145

Total

61,783

Closed

9,747

Merged

51,891

Issues

Open

565

Total

8,085

Closed

7,520

Releases

1

0.1.450

Updated on Sep 04, 2019

View All 1 releases

Languages

3

TypeScript

JavaScript

Shell

TypeScript (99.84%)

JavaScript (0.15%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

52,796,306

Last Day

30,060

Last Week

444,974

Last Month

2,102,778

Last Year

21,533,952

GitHub Statistics

NOASSERTION License

50,005 Stars

89,708 Commits

30,432 Forks

641 Watchers

6 Branches

9,957 Contributors

Updated on Jul 08, 2025

Maintainers

1

View All 9,957 Contributors

Package Meta Information

Latest Version

1.7.5

Package Id

@types/shell-quote@1.7.5

Unpacked Size

5.95 kB

Size

2.14 kB

File Count

5

Published on

Nov 21, 2023

Total Downloads

Cumulative downloads

Total Downloads

52,796,306

Last Day

-2.8%

30,060

Compared to previous day

Last Week

-16.2%

444,974

Compared to previous week

Last Month

3.9%

2,102,778

Compared to previous month

Last Year

98.4%

21,533,952

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

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

1export type ControlOperator = "||" | "&&" | ";;" | "|&" | "<(" | ">>" | ">&" | "&" | ";" | "(" | ")" | "|" | "<" | ">";
2
3export type ParseEntry =
4    | string
5    | { op: ControlOperator }
6    | { op: "glob"; pattern: string }
7    | { comment: string };
8
9export interface ParseOptions {
10    /**
11     * Custom escape character, default value is `\`
12     */
13    escape?: string | undefined;
14}
15
16/**
17 * Return a quoted string for the array `args` suitable for using in shell commands.
18 */
19export function quote(args: readonly string[]): string;
20
21/**
22 * Return an array of arguments from the quoted string `cmd`.
23 *
24 * Interpolate embedded bash-style `$VARNAME` and `${VARNAME}` variables with the `env` object which like bash will replace undefined variables with `""`.
25 */
26export function parse(
27    cmd: string,
28    env?: { readonly [key: string]: string | undefined },
29    opts?: ParseOptions,
30): ParseEntry[];
31
32/**
33 * Return an array of arguments from the quoted string `cmd`.
34 *
35 * Interpolate embedded bash-style `$VARNAME` and `${VARNAME}` variables
36 * with the `env` object which like bash will replace undefined variables with `""`.
37 *
38 * @param env
39 *   A function to perform lookups.
40 *   When env(key) returns a string, its result will be output just like env[key] would.
41 *   When env(key) returns an object, it will be inserted into the result array like the operator objects.
42 */
43export function parse<T extends object | string>(
44    cmd: string,
45    env: (key: string) => T | undefined,
46    opts?: ParseOptions,
47): Array<ParseEntry | T>;
48

Additional Details

Last updated: Mon, 20 Nov 2023 23:36:24 GMT
Dependencies: none

Credits

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

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

9

License

Determines if the project has defined a license.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @types/shell-quote

Other packages similar to @types/shell-quote

@types/shell-quote

Installations

Developer Guide

Yes

N/A

Score

Pull Requests

145

61,783

9,747

51,891

Issues

565

8,085

7,520

Releases

Languages

Developer

DefinitelyTyped

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

52,796,306

Weekly Downloads

Monthly Downloads

Yearly Downloads

Installation

Summary

Details

index.d.ts

Additional Details

Credits

10

10

10

10

10

9

9

8

0

0

0

0

7

/10