Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@types/shelljs

Package Overview
Dependencies
Maintainers
1
Versions
43
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/shelljs - npm Package Compare versions

Comparing version 0.7.4 to 0.7.5

303

shelljs/index.d.ts

@@ -14,3 +14,3 @@ // Type definitions for ShellJS 0.7

* Changes to directory dir for the duration of the script
* @param {string} dir Directory to change in.
* @param dir Directory to change in.
*/

@@ -21,3 +21,3 @@ export function cd(dir: string): void;

* Returns the current directory.
* @return {string} The current directory.
* @return The current directory.
*/

@@ -28,4 +28,4 @@ export function pwd(): string;

* Returns array of files in the given path, or in current directory if no path provided.
* @param {string[]} ...paths Paths to search.
* @return {string[]} An array of files in the given path(s).
* @param ...paths Paths to search.
* @return An array of files in the given path(s).
*/

@@ -36,5 +36,5 @@ export function ls(...paths: string[]): string[];

* Returns array of files in the given path, or in current directory if no path provided.
* @param {string} options Available options: -R (recursive), -A (all files, include files beginning with ., except for . and ..)
* @param {string[]} ...paths Paths to search.
* @return {string[]} An array of files in the given path(s).
* @param options Available options: -R (recursive), -A (all files, include files beginning with ., except for . and ..)
* @param ...paths Paths to search.
* @return An array of files in the given path(s).
*/

@@ -45,4 +45,4 @@ export function ls(options: string, ...paths: string[]): string[];

* Returns array of files in the given path, or in current directory if no path provided.
* @param {string[]} paths Paths to search.
* @return {string[]} An array of files in the given path(s).
* @param paths Paths to search.
* @return An array of files in the given path(s).
*/

@@ -53,5 +53,5 @@ export function ls(paths: string[]): string[];

* Returns array of files in the given path, or in current directory if no path provided.
* @param {string} options Available options: -R (recursive), -A (all files, include files beginning with ., except for . and ..)
* @param {string[]} paths Paths to search.
* @return {string[]} An array of files in the given path(s).
* @param options Available options: -R (recursive), -A (all files, include files beginning with ., except for . and ..)
* @param paths Paths to search.
* @return An array of files in the given path(s).
*/

@@ -62,4 +62,4 @@ export function ls(options: string, paths: string[]): string[];

* Returns array of all files (however deep) in the given paths.
* @param {string[]} ...path The path(s) to search.
* @return {string[]} An array of all files (however deep) in the given path(s).
* @param ...path The path(s) to search.
* @return An array of all files (however deep) in the given path(s).
*/

@@ -70,4 +70,4 @@ export function find(...path: string[]): string[];

* Returns array of all files (however deep) in the given paths.
* @param {string[]} path The path(s) to search.
* @return {string[]} An array of all files (however deep) in the given path(s).
* @param path The path(s) to search.
* @return An array of all files (however deep) in the given path(s).
*/

@@ -78,4 +78,4 @@ export function find(path: string[]): string[];

* Copies files. The wildcard * is accepted.
* @param {string} source The source.
* @param {string} dest The destination.
* @param source The source.
* @param dest The destination.
*/

@@ -86,4 +86,4 @@ export function cp(source: string, dest: string): void;

* Copies files. The wildcard * is accepted.
* @param {string[]} source The source.
* @param {string} dest The destination.
* @param source The source.
* @param dest The destination.
*/

@@ -94,5 +94,5 @@ export function cp(source: string[], dest: string): void;

* Copies files. The wildcard * is accepted.
* @param {string} options Available options: -f (force), -r, -R (recursive)
* @param {strin]} source The source.
* @param {string} dest The destination.
* @param options Available options: -f (force), -r, -R (recursive)
* @param source The source.
* @param dest The destination.
*/

@@ -103,5 +103,5 @@ export function cp(options: string, source: string, dest: string): void;

* Copies files. The wildcard * is accepted.
* @param {string} options Available options: -f (force), -r, -R (recursive)
* @param {string[]} source The source.
* @param {string} dest The destination.
* @param options Available options: -f (force), -r, -R (recursive)
* @param source The source.
* @param dest The destination.
*/

@@ -112,3 +112,3 @@ export function cp(options: string, source: string[], dest: string): void;

* Removes files. The wildcard * is accepted.
* @param {string[]} ...files Files to remove.
* @param ...files Files to remove.
*/

@@ -119,3 +119,3 @@ export function rm(...files: string[]): void;

* Removes files. The wildcard * is accepted.
* @param {string[]} files Files to remove.
* @param files Files to remove.
*/

@@ -126,4 +126,4 @@ export function rm(files: string[]): void;

* Removes files. The wildcard * is accepted.
* @param {string} options Available options: -f (force), -r, -R (recursive)
* @param {string[]} ...files Files to remove.
* @param options Available options: -f (force), -r, -R (recursive)
* @param ...files Files to remove.
*/

@@ -134,4 +134,4 @@ export function rm(options: string, ...files: string[]): void;

* Removes files. The wildcard * is accepted.
* @param {string} options Available options: -f (force), -r, -R (recursive)
* @param {string[]} ...files Files to remove.
* @param options Available options: -f (force), -r, -R (recursive)
* @param ...files Files to remove.
*/

@@ -142,4 +142,4 @@ export function rm(options: string, files: string[]): void;

* Moves files. The wildcard * is accepted.
* @param {string} source The source.
* @param {string} dest The destination.
* @param source The source.
* @param dest The destination.
*/

@@ -150,4 +150,4 @@ export function mv(source: string, dest: string): void;

* Moves files. The wildcard * is accepted.
* @param {string[]} source The source.
* @param {string} dest The destination.
* @param source The source.
* @param dest The destination.
*/

@@ -158,3 +158,3 @@ export function mv(source: string[], dest: string): void;

* Creates directories.
* @param {string[]} ...dir Directories to create.
* @param ...dir Directories to create.
*/

@@ -165,3 +165,3 @@ export function mkdir(...dir: string[]): void;

* Creates directories.
* @param {string[]} dir Directories to create.
* @param dir Directories to create.
*/

@@ -172,4 +172,4 @@ export function mkdir(dir: string[]): void;

* Creates directories.
* @param {string} options Available options: p (full paths, will create intermediate dirs if necessary)
* @param {string[]} ...dir The directories to create.
* @param options Available options: p (full paths, will create intermediate dirs if necessary)
* @param ...dir The directories to create.
*/

@@ -180,4 +180,4 @@ export function mkdir(options: string, ...dir: string[]): void;

* Creates directories.
* @param {string} options Available options: p (full paths, will create intermediate dirs if necessary)
* @param {string[]} dir The directories to create.
* @param options Available options: p (full paths, will create intermediate dirs if necessary)
* @param dir The directories to create.
*/

@@ -188,5 +188,5 @@ export function mkdir(options: string, dir: string[]): void;

* Evaluates expression using the available primaries and returns corresponding value.
* @param {string} option '-b': true if path is a block device; '-c': true if path is a character device; '-d': true if path is a directory; '-e': true if path exists; '-f': true if path is a regular file; '-L': true if path is a symboilc link; '-p': true if path is a pipe (FIFO); '-S': true if path is a socket
* @param {string} path The path.
* @return {boolean} See option parameter.
* @param option '-b': true if path is a block device; '-c': true if path is a character device; '-d': true if path is a directory; '-e': true if path exists; '-f': true if path is a regular file; '-L': true if path is a symboilc link; '-p': true if path is a pipe (FIFO); '-S': true if path is a socket
* @param path The path.
* @return See option parameter.
*/

@@ -197,4 +197,4 @@ export function test(option: string, path: string): boolean;

* Returns a string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file). Wildcard * accepted.
* @param {string[]} ...files Files to use.
* @return {string} A string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file).
* @param ...files Files to use.
* @return A string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file).
*/

@@ -205,4 +205,4 @@ export function cat(...files: string[]): string;

* Returns a string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file). Wildcard * accepted.
* @param {string[]} files Files to use.
* @return {string} A string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file).
* @param files Files to use.
* @return A string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file).
*/

@@ -215,3 +215,3 @@ export function cat(files: string[]): string;

* Analogous to the redirection operator > in Unix, but works with JavaScript strings (such as those returned by cat, grep, etc). Like Unix redirections, to() will overwrite any existing file!
* @param {string} file The file to use.
* @param file The file to use.
*/

@@ -222,3 +222,3 @@ to(file: string): void;

* Analogous to the redirect-and-append operator >> in Unix, but works with JavaScript strings (such as those returned by cat, grep, etc).
* @param {string} file The file to append to.
* @param file The file to append to.
*/

@@ -230,6 +230,6 @@ toEnd(file: string): void;

* Reads an input string from file and performs a JavaScript replace() on the input using the given search regex and replacement string or function. Returns the new string after replacement.
* @param {RegExp} searchRegex The regular expression to use for search.
* @param {string} replacement The replacement.
* @param {string} file The file to process.
* @return {string} The new string after replacement.
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @param file The file to process.
* @return The new string after replacement.
*/

@@ -240,6 +240,6 @@ export function sed(searchRegex: RegExp, replacement: string, file: string): string;

* Reads an input string from file and performs a JavaScript replace() on the input using the given search regex and replacement string or function. Returns the new string after replacement.
* @param {string} searchRegex The regular expression to use for search.
* @param {string} replacement The replacement.
* @param {string} file The file to process.
* @return {string} The new string after replacement.
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @param file The file to process.
* @return The new string after replacement.
*/

@@ -250,7 +250,7 @@ export function sed(searchRegex: string, replacement: string, file: string): string;

* Reads an input string from file and performs a JavaScript replace() on the input using the given search regex and replacement string or function. Returns the new string after replacement.
* @param {string} options Available options: -i (Replace contents of 'file' in-place. Note that no backups will be created!)
* @param {RegExp} searchRegex The regular expression to use for search.
* @param {string} replacement The replacement.
* @param {string} file The file to process.
* @return {string} The new string after replacement.
* @param options Available options: -i (Replace contents of 'file' in-place. Note that no backups will be created!)
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @param file The file to process.
* @return The new string after replacement.
*/

@@ -261,7 +261,7 @@ export function sed(options: string, searchRegex: RegExp, replacement: string, file: string): string;

* Reads an input string from file and performs a JavaScript replace() on the input using the given search regex and replacement string or function. Returns the new string after replacement.
* @param {string} options Available options: -i (Replace contents of 'file' in-place. Note that no backups will be created!)
* @param {string} searchRegex The regular expression to use for search.
* @param {string} replacement The replacement.
* @param {string} file The file to process.
* @return {string} The new string after replacement.
* @param options Available options: -i (Replace contents of 'file' in-place. Note that no backups will be created!)
* @param searchRegex The regular expression to use for search.
* @param replacement The replacement.
* @param file The file to process.
* @return The new string after replacement.
*/

@@ -272,5 +272,5 @@ export function sed(options: string, searchRegex: string, replacement: string, file: string): string;

* Reads input string from given files and returns a string containing all lines of the file that match the given regex_filter. Wildcard * accepted.
* @param {RegExp} regex_filter The regular expression to use.
* @param {string[]} ...files The files to process.
* @return {string} Returns a string containing all lines of the file that match the given regex_filter.
* @param regex_filter The regular expression to use.
* @param ...files The files to process.
* @return Returns a string containing all lines of the file that match the given regex_filter.
*/

@@ -281,5 +281,5 @@ export function grep(regex_filter: RegExp, ...files: string[]): string;

* Reads input string from given files and returns a string containing all lines of the file that match the given regex_filter. Wildcard * accepted.
* @param {RegExp} regex_filter The regular expression to use.
* @param {string[]} ...files The files to process.
* @return {string} Returns a string containing all lines of the file that match the given regex_filter.
* @param regex_filter The regular expression to use.
* @param ...files The files to process.
* @return Returns a string containing all lines of the file that match the given regex_filter.
*/

@@ -290,6 +290,6 @@ export function grep(regex_filter: RegExp, files: string[]): string;

* Reads input string from given files and returns a string containing all lines of the file that match the given regex_filter. Wildcard * accepted.
* @param {string} options Available options: -v (Inverse the sense of the regex and print the lines not matching the criteria.)
* @param {string} regex_filter The regular expression to use.
* @param {string[]} ...files The files to process.
* @return {string} Returns a string containing all lines of the file that match the given regex_filter.
* @param options Available options: -v (Inverse the sense of the regex and print the lines not matching the criteria.)
* @param regex_filter The regular expression to use.
* @param ...files The files to process.
* @return Returns a string containing all lines of the file that match the given regex_filter.
*/

@@ -300,6 +300,6 @@ export function grep(options: string, regex_filter: string, ...files: string[]): string;

* Reads input string from given files and returns a string containing all lines of the file that match the given regex_filter. Wildcard * accepted.
* @param {string} options Available options: -v (Inverse the sense of the regex and print the lines not matching the criteria.)
* @param {string} regex_filter The regular expression to use.
* @param {string[]} files The files to process.
* @return {string} Returns a string containing all lines of the file that match the given regex_filter.
* @param options Available options: -v (Inverse the sense of the regex and print the lines not matching the criteria.)
* @param regex_filter The regular expression to use.
* @param files The files to process.
* @return Returns a string containing all lines of the file that match the given regex_filter.
*/

@@ -310,4 +310,4 @@ export function grep(options: string, regex_filter: string, files: string[]): string;

* Searches for command in the system's PATH. On Windows looks for .exe, .cmd, and .bat extensions.
* @param {string} command The command to search for.
* @return {string} Returns string containing the absolute path to the command.
* @param command The command to search for.
* @return Returns string containing the absolute path to the command.
*/

@@ -318,4 +318,4 @@ export function which(command: string): string;

* Prints string to stdout, and returns string with additional utility methods like .to().
* @param {string[]} ...text The text to print.
* @return {string} Returns the string that was passed as argument.
* @param ...text The text to print.
* @return Returns the string that was passed as argument.
*/

@@ -326,4 +326,4 @@ export function echo(...text: string[]): string;

* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @param {"+N"} dir Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
* @return {string[]} Returns an array of paths in the stack.
* @param dir Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
* @return Returns an array of paths in the stack.
*/

@@ -334,4 +334,4 @@ export function pushd(dir: "+N"): string[];

* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @param {"-N"} dir Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
* @return {string[]} Returns an array of paths in the stack.
* @param dir Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
* @return Returns an array of paths in the stack.
*/

@@ -342,4 +342,4 @@ export function pushd(dir: "-N"): string[];

* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @param {string} dir Makes the current working directory be the top of the stack, and then executes the equivalent of cd dir.
* @return {string[]} Returns an array of paths in the stack.
* @param dir Makes the current working directory be the top of the stack, and then executes the equivalent of cd dir.
* @return Returns an array of paths in the stack.
*/

@@ -350,5 +350,5 @@ export function pushd(dir: string): string[];

* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @param {string} options Available options: -n (Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated)
* @param {"+N"} dir Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
* @return {string[]} Returns an array of paths in the stack.
* @param options Available options: -n (Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated)
* @param dir Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
* @return Returns an array of paths in the stack.
*/

@@ -359,5 +359,5 @@ export function pushd(options: string, dir: "+N"): string[];

* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @param {string} options Available options: -n (Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated)
* @param {"-N"} dir Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
* @return {string[]} Returns an array of paths in the stack.
* @param options Available options: -n (Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated)
* @param dir Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
* @return Returns an array of paths in the stack.
*/

@@ -368,5 +368,5 @@ export function pushd(options: string, dir: "-N"): string[];

* Save the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
* @param {string} options Available options: -n (Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated)
* @param {string} dir Makes the current working directory be the top of the stack, and then executes the equivalent of cd dir.
* @return {string[]} Returns an array of paths in the stack.
* @param options Available options: -n (Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated)
* @param dir Makes the current working directory be the top of the stack, and then executes the equivalent of cd dir.
* @return Returns an array of paths in the stack.
*/

@@ -377,4 +377,4 @@ export function pushd(options: string, dir: string): string[];

* When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
* @param {"+N"} dir Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
* @return {string[]} Returns an array of paths in the stack.
* @param dir Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/

@@ -385,3 +385,3 @@ export function popd(dir: "+N"): string[];

* When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
* @return {string[]} Returns an array of paths in the stack.
* @return Returns an array of paths in the stack.
*/

@@ -392,4 +392,4 @@ export function popd(): string[];

* When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
* @param {"-N"} dir Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.
* @return {string[]} Returns an array of paths in the stack.
* @param dir Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/

@@ -400,4 +400,4 @@ export function popd(dir: "-N"): string[];

* When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
* @param {string} dir You can only use -N and +N.
* @return {string[]} Returns an array of paths in the stack.
* @param dir You can only use -N and +N.
* @return Returns an array of paths in the stack.
*/

@@ -408,5 +408,5 @@ export function popd(dir: string): string[];

* When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
* @param {string} options Available options: -n (Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated)
* @param {"+N"} dir Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
* @return {string[]} Returns an array of paths in the stack.
* @param options Available options: -n (Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated)
* @param dir Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/

@@ -417,5 +417,5 @@ export function popd(options: string, dir: "+N"): string[];

* When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
* @param {string} options Available options: -n (Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated)
* @param {"-N"} dir Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.
* @return {string[]} Returns an array of paths in the stack.
* @param options Available options: -n (Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated)
* @param dir Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.
* @return Returns an array of paths in the stack.
*/

@@ -426,5 +426,5 @@ export function popd(options: string, dir: "-N"): string[];

* When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
* @param {string} options Available options: -n (Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated)
* @param {string} dir You can only use -N and +N.
* @return {string[]} Returns an array of paths in the stack.
* @param options Available options: -n (Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated)
* @param dir You can only use -N and +N.
* @return Returns an array of paths in the stack.
*/

@@ -435,4 +435,4 @@ export function popd(options: string, dir: string): string[];

* Clears the directory stack by deleting all of the elements.
* @param {"-c"} options Clears the directory stack by deleting all of the elements.
* @return {string[]} Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @param options Clears the directory stack by deleting all of the elements.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/

@@ -443,4 +443,4 @@ export function dirs(options: "-c"): string[];

* Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @param {"+N"} options Displays the Nth directory (counting from the left of the list printed by dirs when invoked without options), starting with zero.
* @return {string[]} Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @param options Displays the Nth directory (counting from the left of the list printed by dirs when invoked without options), starting with zero.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/

@@ -451,4 +451,4 @@ export function dirs(options: "+N"): string;

* Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @param {"-N"} options Displays the Nth directory (counting from the right of the list printed by dirs when invoked without options), starting with zero.
* @return {string[]} Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @param options Displays the Nth directory (counting from the right of the list printed by dirs when invoked without options), starting with zero.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/

@@ -459,4 +459,4 @@ export function dirs(options: "-N"): string;

* Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @param {string} options Available options: -c, -N, +N. You can only use those.
* @return {any} Returns an array of paths in the stack, or a single path if +N or -N was specified.
* @param options Available options: -c, -N, +N. You can only use those.
* @return Returns an array of paths in the stack, or a single path if +N or -N was specified.
*/

@@ -467,4 +467,4 @@ export function dirs(options: string): any;

* Links source to dest. Use -f to force the link, should dest already exist.
* @param {string} source The source.
* @param {string} dest The destination.
* @param source The source.
* @param dest The destination.
*/

@@ -475,5 +475,5 @@ export function ln(source: string, dest: string): void;

* Links source to dest. Use -f to force the link, should dest already exist.
* @param {string} options Available options: s (symlink), f (force)
* @param {string} source The source.
* @param {string} dest The destination.
* @param options Available options: s (symlink), f (force)
* @param source The source.
* @param dest The destination.
*/

@@ -484,3 +484,3 @@ export function ln(options: string, source: string, dest: string): void;

* Exits the current process with the given exit code.
* @param {number} code The exit code.
* @param code The exit code.
*/

@@ -496,4 +496,4 @@ export function exit(code: number): void;

* Executes the given command synchronously.
* @param {string} command The command to execute.
* @return {ExecOutputReturnValue} Returns an object containing the return code and output as string.
* @param command The command to execute.
* @return Returns an object containing the return code and output as string.
*/

@@ -503,5 +503,5 @@ export function exec(command: string): ExecOutputReturnValue;

* Executes the given command synchronously.
* @param {string} command The command to execute.
* @param {ExecOptions} options Silence and synchronous options.
* @return {ExecOutputReturnValue | child.ChildProcess} Returns an object containing the return code and output as string, or if {async:true} was passed, a ChildProcess.
* @param command The command to execute.
* @param options Silence and synchronous options.
* @return Returns an object containing the return code and output as string, or if {async:true} was passed, a ChildProcess.
*/

@@ -511,5 +511,5 @@ export function exec(command: string, options: ExecOptions): ExecOutputReturnValue | child.ChildProcess;

* Executes the given command synchronously.
* @param {string} command The command to execute.
* @param {ExecOptions} options Silence and synchronous options.
* @param {ExecCallback} callback Receives code and output asynchronously.
* @param command The command to execute.
* @param options Silence and synchronous options.
* @param callback Receives code and output asynchronously.
*/

@@ -519,4 +519,4 @@ export function exec(command: string, options: ExecOptions, callback: ExecCallback): child.ChildProcess;

* Executes the given command synchronously.
* @param {string} command The command to execute.
* @param {ExecCallback} callback Receives code and output asynchronously.
* @param command The command to execute.
* @param callback Receives code and output asynchronously.
*/

@@ -542,4 +542,4 @@ export function exec(command: string, callback: ExecCallback): child.ChildProcess;

* - There is no "quiet" option since default behavior is to run silent.
* @param {number} octalMode The access mode. Octal.
* @param {string} file The file to use.
* @param octalMode The access mode. Octal.
* @param file The file to use.
*/

@@ -552,4 +552,4 @@ export function chmod(octalMode: number, file: string): void;

* - There is no "quiet" option since default behavior is to run silent.
* @param {string} mode The access mode. Can be an octal string or a symbolic mode string.
* @param {string} file The file to use.
* @param mode The access mode. Can be an octal string or a symbolic mode string.
* @param file The file to use.
*/

@@ -562,3 +562,3 @@ export function chmod(mode: string, file: string): void;

* Searches and returns string containing a writeable, platform-dependent temporary directory. Follows Python's tempfile algorithm.
* @return {string} The temp file path.
* @return The temp file path.
*/

@@ -569,3 +569,3 @@ export function tempdir(): string;

* Tests if error occurred in the last command.
* @return {string} Returns null if no error occurred, otherwise returns string explaining the error
* @return Returns null if no error occurred, otherwise returns string explaining the error
*/

@@ -596,3 +596,2 @@ export function error(): string;

* Suppresses all command output if true, except for echo() calls. Default is false.
* @type {boolean}
*/

@@ -603,3 +602,2 @@ silent: boolean;

* If true the script will die on errors. Default is false.
* @type {boolean}
*/

@@ -610,3 +608,2 @@ fatal: boolean;

* Will print each executed command to the screen. Default is true.
* @type {boolean}
*/

@@ -617,3 +614,2 @@ verbose: boolean;

* Passed to glob.sync() instead of the default options ({}).
* @type {glob.IOptions}
*/

@@ -624,3 +620,2 @@ globOptions: glob.IOptions;

* Absolute path of the Node binary. Default is null (inferred).
* @type {string|null}
*/

@@ -631,3 +626,2 @@ execPath: string | null;

* Reset shell.config to the defaults.
* @returns {void}
*/

@@ -639,4 +633,3 @@ reset(): void;

* The shelljs configuration.
* @type {ShellConfig}
*/
export const config: ShellConfig;

11

shelljs/package.json
{
"name": "@types/shelljs",
"version": "0.7.4",
"version": "0.7.5",
"description": "TypeScript definitions for ShellJS",

@@ -9,7 +9,9 @@ "license": "MIT",

"name": "Niklas Mollenhauer",
"url": "https://github.com/nikeee"
"url": "https://github.com/nikeee",
"githubUsername": "nikeee"
},
{
"name": "Vojtech Jasny",
"url": "https://github.com/voy"
"url": "https://github.com/voy",
"githubUsername": "voy"
}

@@ -27,5 +29,4 @@ ],

},
"peerDependencies": {},
"typesPublisherContentHash": "6052e869eb634ed11bad45adf045ab4e0f385519e1e4c2b8ad7d0f82cdc2ee3e",
"typesPublisherContentHash": "a4d55e8f598a8106a4487edbd2ee9f2fd52546064f0d7d6a1c60e7954c2397e8",
"typeScriptVersion": "2.0"
}

2

shelljs/README.md

@@ -11,3 +11,3 @@ # Installation

Additional Details
* Last updated: Thu, 03 Aug 2017 13:57:01 GMT
* Last updated: Wed, 25 Oct 2017 16:18:58 GMT
* Dependencies: child_process, glob, node

@@ -14,0 +14,0 @@ * Global values: none

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc