@types/shell-escape - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

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
 
-type ShellEscape = (a: string[]) => string;
+/**
+ * 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;
 
-declare const shellEscape: ShellEscape;
-
 export = shellEscape;

shell-escape/package.json

 {
     "name": "@types/shell-escape",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "description": "TypeScript definitions for shell-escape",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shell-escape",
     "license": "MIT",
@@ -11,13 +12,20 @@ "contributors": [
             "githubUsername": "nenadalm"
+        },
+        {
+            "name": "BendingBender",
+            "url": "https://github.com/BendingBender",
+            "githubUsername": "BendingBender"
         }
     ],
     "main": "",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://www.github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/shell-escape"
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "35d529a4f1df6a7c9647cef0eb64448dd7ed651190747ad1912178a38832d64c",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "ba794a4768f3a5764545ffb140ceb2f13cbb0b02166e3316a1566fccdaaf039a",
+    "typeScriptVersion": "4.0"
 }

shell-escape/README.md

@@ -8,6 +8,33 @@ # Installation
 # Details
-Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shell-escape
+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
+// 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
 
-Additional Details
- * Last updated: Thu, 31 Aug 2017 14:05:17 GMT
+/**
+ * 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
@@ -17,2 +44,2 @@ * Global values: none
 # Credits
-These definitions were written by Miloslav Nenadál <https://github.com/nenadalm>.
+These definitions were written by [Miloslav Nenadál](https://github.com/nenadalm), and [BendingBender](https://github.com/BendingBender).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4819

increased by78.95%

Lines of code

21

increased by200%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

44

increased by158.82%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes