@types/shelljs
Advanced tools
@types/shelljs - npm Package Compare versions
Comparing version 0.8.7 to 0.8.8
@@ -33,26 +33,26 @@ // Type definitions for ShellJS 0.8 | ||
| export interface ListFunction { | ||
| /** | ||
| * Returns array of files in the given path, or in current directory if no path provided. | ||
| * | ||
| * @param options Available options: | ||
| * - `-R`: recursive | ||
| * - `-A`: all files (include files beginning with ., except for . and ..) | ||
| * - `-L`: follow symlinks | ||
| * - `-d`: list directories themselves, not their contents | ||
| * - `-l`: list objects representing each file, each with fields containing | ||
| * `ls -l` output fields. See fs.Stats for more info | ||
| * @param paths Paths to search. | ||
| * @return An array of files in the given path(s). | ||
| */ | ||
| (options: string, paths: string[]): ShellArray; | ||
| (options: string, ...paths: string[]): ShellArray; | ||
| /** | ||
| * Returns array of files in the given path, or in current directory if no path provided. | ||
| * | ||
| * @param options Available options: | ||
| * - `-R`: recursive | ||
| * - `-A`: all files (include files beginning with ., except for . and ..) | ||
| * - `-L`: follow symlinks | ||
| * - `-d`: list directories themselves, not their contents | ||
| * - `-l`: list objects representing each file, each with fields containing | ||
| * `ls -l` output fields. See fs.Stats for more info | ||
| * @param paths Paths to search. | ||
| * @return An array of files in the given path(s). | ||
| */ | ||
| (options: string, paths: string[]): ShellArray; | ||
| (options: string, ...paths: string[]): ShellArray; | ||
| /** | ||
| * Returns array of files in the given path, or in current directory if no path provided. | ||
| * | ||
| * @param paths Paths to search. | ||
| * @return An array of files in the given path(s). | ||
| */ | ||
| (paths: string[]): ShellArray; | ||
| (...paths: string[]): ShellArray; | ||
| /** | ||
| * Returns array of files in the given path, or in current directory if no path provided. | ||
| * | ||
| * @param paths Paths to search. | ||
| * @return An array of files in the given path(s). | ||
| */ | ||
| (paths: string[]): ShellArray; | ||
| (...paths: string[]): ShellArray; | ||
| } | ||
@@ -76,10 +76,10 @@ | ||
| export interface FindFunction { | ||
| /** | ||
| * Returns array of all files (however deep) in the given paths. | ||
| * | ||
| * @param path The path(s) to search. | ||
| * @return An array of all files (however deep) in the given path(s). | ||
| */ | ||
| (path: string[]): ShellArray; | ||
| (...path: string[]): ShellArray; | ||
| /** | ||
| * Returns array of all files (however deep) in the given paths. | ||
| * | ||
| * @param path The path(s) to search. | ||
| * @return An array of all files (however deep) in the given path(s). | ||
| */ | ||
| (path: string[]): ShellArray; | ||
| (...path: string[]): ShellArray; | ||
| } | ||
@@ -96,26 +96,26 @@ | ||
| export interface CopyFunction { | ||
| /** | ||
| * Copies files. The wildcard `*` is accepted. | ||
| * | ||
| * @param options Available options: | ||
| * - `-f`: force (default behavior) | ||
| * - `-n`: no-clobber | ||
| * - `-u`: only copy if source is newer than dest | ||
| * - `-r`, `-R`: recursive | ||
| * - `-L`: follow symlinks | ||
| * - `-P`: don't follow symlinks | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, source: string | string[], dest: string): ShellString; | ||
| /** | ||
| * Copies files. The wildcard `*` is accepted. | ||
| * | ||
| * @param options Available options: | ||
| * - `-f`: force (default behavior) | ||
| * - `-n`: no-clobber | ||
| * - `-u`: only copy if source is newer than dest | ||
| * - `-r`, `-R`: recursive | ||
| * - `-L`: follow symlinks | ||
| * - `-P`: don't follow symlinks | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, source: string | string[], dest: string): ShellString; | ||
| /** | ||
| * Copies files. The wildcard `*` is accepted. | ||
| * | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (source: string | string[], dest: string): ShellString; | ||
| /** | ||
| * Copies files. The wildcard `*` is accepted. | ||
| * | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (source: string | string[], dest: string): ShellString; | ||
| } | ||
@@ -140,22 +140,22 @@ | ||
| export interface RemoveFunction { | ||
| /** | ||
| * Removes files. The wildcard `*` is accepted. | ||
| * | ||
| * @param options Available options: | ||
| * - `-f`: force | ||
| * - `-r`, `-R`: recursive | ||
| * @param files Files to remove. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, files: string[]): ShellString; | ||
| (options: string, ...files: string[]): ShellString; | ||
| /** | ||
| * Removes files. The wildcard `*` is accepted. | ||
| * | ||
| * @param options Available options: | ||
| * - `-f`: force | ||
| * - `-r`, `-R`: recursive | ||
| * @param files Files to remove. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, files: string[]): ShellString; | ||
| (options: string, ...files: string[]): ShellString; | ||
| /** | ||
| * Removes files. The wildcard `*` is accepted. | ||
| * | ||
| * @param files Files to remove. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| /** | ||
| * Removes files. The wildcard `*` is accepted. | ||
| * | ||
| * @param files Files to remove. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| } | ||
@@ -175,22 +175,22 @@ | ||
| export interface MoveFunction { | ||
| /** | ||
| * Moves files. The wildcard `*` is accepted. | ||
| * | ||
| * @param options Available options: | ||
| * - `-f`: force (default behavior) | ||
| * - `-n`: no-clobber | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, source: string | string[], dest: string): ShellString; | ||
| /** | ||
| * Moves files. The wildcard `*` is accepted. | ||
| * | ||
| * @param options Available options: | ||
| * - `-f`: force (default behavior) | ||
| * - `-n`: no-clobber | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, source: string | string[], dest: string): ShellString; | ||
| /** | ||
| * Moves files. The wildcard `*` is accepted. | ||
| * | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (source: string | string[], dest: string): ShellString; | ||
| /** | ||
| * Moves files. The wildcard `*` is accepted. | ||
| * | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (source: string | string[], dest: string): ShellString; | ||
| } | ||
@@ -211,21 +211,21 @@ | ||
| export interface MkdirFunction { | ||
| /** | ||
| * Creates directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-p`: full paths, will create intermediate dirs if necessary | ||
| * @param dir The directories to create. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, dir: string[]): ShellString; | ||
| (options: string, ...dir: string[]): ShellString; | ||
| /** | ||
| * Creates directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-p`: full paths, will create intermediate dirs if necessary | ||
| * @param dir The directories to create. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, dir: string[]): ShellString; | ||
| (options: string, ...dir: string[]): ShellString; | ||
| /** | ||
| * Creates directories. | ||
| * | ||
| * @param dir Directories to create. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (dir: string[]): ShellString; | ||
| (...dir: string[]): ShellString; | ||
| /** | ||
| * Creates directories. | ||
| * | ||
| * @param dir Directories to create. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (dir: string[]): ShellString; | ||
| (...dir: string[]): ShellString; | ||
| } | ||
@@ -263,14 +263,14 @@ | ||
| export interface CatFunction { | ||
| /** | ||
| * 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). | ||
| * | ||
| * @param files Files to use. Wildcard `*` accepted. | ||
| * @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). | ||
| */ | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| /** | ||
| * 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). | ||
| * | ||
| * @param files Files to use. Wildcard `*` accepted. | ||
| * @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). | ||
| */ | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| } | ||
@@ -291,45 +291,45 @@ | ||
| export interface SedFunction { | ||
| /** | ||
| * Reads an input string from file and performs a JavaScript `replace()` | ||
| * on the input using the given search regex and replacement string or function. | ||
| * | ||
| * @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 files The files to process. | ||
| * @return The new string after replacement. | ||
| */ | ||
| ( | ||
| options: string, | ||
| searchRegex: string | RegExp, | ||
| replacement: string, | ||
| files: string[] | ||
| ): ShellString; | ||
| ( | ||
| options: string, | ||
| searchRegex: string | RegExp, | ||
| replacement: string, | ||
| ...files: string[] | ||
| ): ShellString; | ||
| /** | ||
| * Reads an input string from file and performs a JavaScript `replace()` | ||
| * on the input using the given search regex and replacement string or function. | ||
| * | ||
| * @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 files The files to process. | ||
| * @return The new string after replacement. | ||
| */ | ||
| ( | ||
| options: string, | ||
| searchRegex: string | RegExp, | ||
| replacement: string, | ||
| files: string[] | ||
| ): ShellString; | ||
| ( | ||
| options: string, | ||
| searchRegex: string | RegExp, | ||
| replacement: string, | ||
| ...files: string[] | ||
| ): ShellString; | ||
| /** | ||
| * Reads an input string from file and performs a JavaScript `replace()` | ||
| * on the input using the given search regex and replacement string or function. | ||
| * | ||
| * @param searchRegex The regular expression to use for search. | ||
| * @param replacement The replacement. | ||
| * @param files The files to process. | ||
| * @return The new string after replacement. | ||
| */ | ||
| ( | ||
| searchRegex: string | RegExp, | ||
| replacement: string, | ||
| files: string[] | ||
| ): ShellString; | ||
| ( | ||
| searchRegex: string | RegExp, | ||
| replacement: string, | ||
| ...files: string[] | ||
| ): ShellString; | ||
| /** | ||
| * Reads an input string from file and performs a JavaScript `replace()` | ||
| * on the input using the given search regex and replacement string or function. | ||
| * | ||
| * @param searchRegex The regular expression to use for search. | ||
| * @param replacement The replacement. | ||
| * @param files The files to process. | ||
| * @return The new string after replacement. | ||
| */ | ||
| ( | ||
| searchRegex: string | RegExp, | ||
| replacement: string, | ||
| files: string[] | ||
| ): ShellString; | ||
| ( | ||
| searchRegex: string | RegExp, | ||
| replacement: string, | ||
| ...files: string[] | ||
| ): ShellString; | ||
| } | ||
@@ -351,35 +351,35 @@ | ||
| export interface GrepFunction { | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-v`: Inverse the sense of the regex and print | ||
| * the lines not matching the criteria. | ||
| * - `-l`: Print only filenames of matching files | ||
| * @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. | ||
| */ | ||
| ( | ||
| options: string, | ||
| regex_filter: string | RegExp, | ||
| files: string[] | ||
| ): ShellString; | ||
| ( | ||
| options: string, | ||
| regex_filter: string | RegExp, | ||
| ...files: string[] | ||
| ): ShellString; | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-v`: Inverse the sense of the regex and print | ||
| * the lines not matching the criteria. | ||
| * - `-l`: Print only filenames of matching files | ||
| * @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. | ||
| */ | ||
| ( | ||
| options: string, | ||
| regex_filter: string | RegExp, | ||
| files: string[] | ||
| ): ShellString; | ||
| ( | ||
| options: string, | ||
| regex_filter: string | RegExp, | ||
| ...files: string[] | ||
| ): ShellString; | ||
| /** | ||
| * 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 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`. | ||
| */ | ||
| (regex_filter: string | RegExp, files: string[]): ShellString; | ||
| (regex_filter: string | RegExp, ...files: string[]): ShellString; | ||
| /** | ||
| * 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 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`. | ||
| */ | ||
| (regex_filter: string | RegExp, files: string[]): ShellString; | ||
| (regex_filter: string | RegExp, ...files: string[]): ShellString; | ||
| } | ||
@@ -410,20 +410,20 @@ | ||
| export interface EchoFunction { | ||
| /** | ||
| * Prints string to stdout, and returns string with additional utility methods like .to(). | ||
| * | ||
| * @param options Available options: | ||
| * - `-e`: interpret backslash escapes (default) | ||
| * - `-n`: remove trailing newline from output | ||
| * @param text The text to print. | ||
| * @return Returns the string that was passed as argument. | ||
| */ | ||
| (options: string, ...text: string[]): ShellString; | ||
| /** | ||
| * Prints string to stdout, and returns string with additional utility methods like .to(). | ||
| * | ||
| * @param options Available options: | ||
| * - `-e`: interpret backslash escapes (default) | ||
| * - `-n`: remove trailing newline from output | ||
| * @param text The text to print. | ||
| * @return Returns the string that was passed as argument. | ||
| */ | ||
| (options: string, ...text: string[]): ShellString; | ||
| /** | ||
| * Prints string to stdout, and returns string with additional utility methods like .to(). | ||
| * | ||
| * @param text The text to print. | ||
| * @return Returns the string that was passed as argument. | ||
| */ | ||
| (...text: string[]): ShellString; | ||
| /** | ||
| * Prints string to stdout, and returns string with additional utility methods like .to(). | ||
| * | ||
| * @param text The text to print. | ||
| * @return Returns the string that was passed as argument. | ||
| */ | ||
| (...text: string[]): ShellString; | ||
| } | ||
@@ -443,81 +443,81 @@ | ||
| export interface PushDirFunction { | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when adding directories | ||
| * to the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: "+N"): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when adding directories | ||
| * to the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: "+N"): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when adding directories | ||
| * to the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: "-N"): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when adding directories | ||
| * to the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: "-N"): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when adding directories | ||
| * to the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: string): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when adding directories | ||
| * to the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: string): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (dir: "+N"): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (dir: "+N"): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (dir: "-N"): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (dir: "-N"): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (dir: string): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (dir: string): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @return Returns an array of paths in the stack. | ||
| */ | ||
| (): ShellArray; | ||
| /** | ||
| * Saves the current directory on the top of the directory stack and then cd to dir. | ||
| * With no arguments, `pushd` exchanges the top two directories. | ||
| * | ||
| * @return Returns an array of paths in the stack. | ||
| */ | ||
| (): ShellArray; | ||
| } | ||
@@ -540,96 +540,96 @@ | ||
| export interface PopDirFunction { | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when removing directories | ||
| * from the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: "+N"): ShellArray; | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when removing directories | ||
| * from the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: "+N"): ShellArray; | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when removing directories | ||
| * from the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: "-N"): ShellArray; | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when removing directories | ||
| * from the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @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. | ||
| */ | ||
| (options: string, dir: "-N"): ShellArray; | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when removing directories | ||
| * from the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @param dir You can only use -N and +N. | ||
| * @return Returns an array of paths in the stack. | ||
| */ | ||
| (options: string, dir: string): ShellArray; | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-n`: Suppresses the normal change of directory when removing directories | ||
| * from the stack, so that only the stack is manipulated | ||
| * - `-q`: Suppresses output to the console. | ||
| * @param dir You can only use -N and +N. | ||
| * @return Returns an array of paths in the stack. | ||
| */ | ||
| (options: string, dir: string): ShellArray; | ||
| /** | ||
| * 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 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. | ||
| */ | ||
| (dir: "+N"): ShellArray; | ||
| /** | ||
| * 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 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. | ||
| */ | ||
| (dir: "+N"): ShellArray; | ||
| /** | ||
| * 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 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. | ||
| */ | ||
| (dir: "-N"): ShellArray; | ||
| /** | ||
| * 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 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. | ||
| */ | ||
| (dir: "-N"): ShellArray; | ||
| /** | ||
| * 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 dir You can only use -N and +N. | ||
| * @return Returns an array of paths in the stack. | ||
| */ | ||
| (dir: string): ShellArray; | ||
| /** | ||
| * 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 dir You can only use -N and +N. | ||
| * @return Returns an array of paths in the stack. | ||
| */ | ||
| (dir: string): ShellArray; | ||
| /** | ||
| * 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 Returns an array of paths in the stack. | ||
| */ | ||
| (): ShellArray; | ||
| /** | ||
| * 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 Returns an array of paths in the stack. | ||
| */ | ||
| (): ShellArray; | ||
| } | ||
@@ -654,40 +654,40 @@ | ||
| export interface DirsFunction { | ||
| /** | ||
| * Clears the directory stack by deleting all of the elements. | ||
| * | ||
| * @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. | ||
| */ | ||
| (options: "-c"): ShellArray; | ||
| /** | ||
| * Clears the directory stack by deleting all of the elements. | ||
| * | ||
| * @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. | ||
| */ | ||
| (options: "-c"): ShellArray; | ||
| /** | ||
| * Displays the list of currently remembered directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (options: "+N"): ShellString; | ||
| /** | ||
| * Displays the list of currently remembered directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (options: "+N"): ShellString; | ||
| /** | ||
| * Displays the list of currently remembered directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (options: "-N"): ShellString; | ||
| /** | ||
| * Displays the list of currently remembered directories. | ||
| * | ||
| * @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. | ||
| */ | ||
| (options: "-N"): ShellString; | ||
| /** | ||
| * Displays the list of currently remembered directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-c`: Clears the directory stack by deleting all of the elements. | ||
| * - `-N`: Displays the Nth directory (counting from the right of the list | ||
| * printed by dirs when invoked without options), starting with zero. | ||
| * - `+N`: 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. | ||
| */ | ||
| (options: string): ShellArray | ShellString; | ||
| /** | ||
| * Displays the list of currently remembered directories. | ||
| * | ||
| * @param options Available options: | ||
| * - `-c`: Clears the directory stack by deleting all of the elements. | ||
| * - `-N`: Displays the Nth directory (counting from the right of the list | ||
| * printed by dirs when invoked without options), starting with zero. | ||
| * - `+N`: 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. | ||
| */ | ||
| (options: string): ShellArray | ShellString; | ||
| } | ||
@@ -709,22 +709,22 @@ | ||
| export interface LinkFunction { | ||
| /** | ||
| * Links source to dest. Use `-f` to force the link, should dest already exist. | ||
| * | ||
| * @param options Available options: | ||
| * - `-s`: Create a symbolic link, defaults to a hardlink | ||
| * - `-f`: Force creation | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, source: string, dest: string): ShellString; | ||
| /** | ||
| * Links source to dest. Use `-f` to force the link, should dest already exist. | ||
| * | ||
| * @param options Available options: | ||
| * - `-s`: Create a symbolic link, defaults to a hardlink | ||
| * - `-f`: Force creation | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, source: string, dest: string): ShellString; | ||
| /** | ||
| * Links source to dest. Use `-f` to force the link, should dest already exist. | ||
| * | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (source: string, dest: string): ShellString; | ||
| /** | ||
| * Links source to dest. Use `-f` to force the link, should dest already exist. | ||
| * | ||
| * @param source The source. | ||
| * @param dest The destination. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (source: string, dest: string): ShellString; | ||
| } | ||
@@ -759,63 +759,63 @@ | ||
| export interface ExecFunction { | ||
| /** | ||
| * Executes the given command synchronously. | ||
| * | ||
| * @param command The command to execute. | ||
| * @return Returns an object containing the return code and output as string. | ||
| */ | ||
| (command: string): ShellString; | ||
| /** | ||
| * Executes the given command synchronously. | ||
| * | ||
| * @param command The command to execute. | ||
| * @return Returns an object containing the return code and output as string. | ||
| */ | ||
| (command: string): ShellString; | ||
| /** | ||
| * Executes the given command synchronously. | ||
| * | ||
| * @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`. | ||
| */ | ||
| (command: string, options: ExecOptions & { async?: false }): ShellString; | ||
| /** | ||
| * Executes the given command synchronously. | ||
| * | ||
| * @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`. | ||
| */ | ||
| (command: string, options: ExecOptions & { async?: false }): ShellString; | ||
| /** | ||
| * Executes the given command asynchronously. | ||
| * | ||
| * @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`. | ||
| */ | ||
| ( | ||
| command: string, | ||
| options: ExecOptions & { async: true } | ||
| ): child.ChildProcess; | ||
| /** | ||
| * Executes the given command asynchronously. | ||
| * | ||
| * @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`. | ||
| */ | ||
| ( | ||
| command: string, | ||
| options: ExecOptions & { async: true } | ||
| ): child.ChildProcess; | ||
| /** | ||
| * Executes the given command. | ||
| * | ||
| * @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`. | ||
| */ | ||
| (command: string, options: ExecOptions): ShellString | child.ChildProcess; | ||
| /** | ||
| * Executes the given command. | ||
| * | ||
| * @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`. | ||
| */ | ||
| (command: string, options: ExecOptions): ShellString | child.ChildProcess; | ||
| /** | ||
| * Executes the given command synchronously. | ||
| * | ||
| * @param command The command to execute. | ||
| * @param options Silence and synchronous options. | ||
| * @param callback Receives code and output asynchronously. | ||
| */ | ||
| ( | ||
| command: string, | ||
| options: ExecOptions, | ||
| callback: ExecCallback | ||
| ): child.ChildProcess; | ||
| /** | ||
| * Executes the given command synchronously. | ||
| * | ||
| * @param command The command to execute. | ||
| * @param options Silence and synchronous options. | ||
| * @param callback Receives code and output asynchronously. | ||
| */ | ||
| ( | ||
| command: string, | ||
| options: ExecOptions, | ||
| callback: ExecCallback | ||
| ): child.ChildProcess; | ||
| /** | ||
| * Executes the given command synchronously. | ||
| * | ||
| * @param command The command to execute. | ||
| * @param callback Receives code and output asynchronously. | ||
| */ | ||
| (command: string, callback: ExecCallback): child.ChildProcess; | ||
| /** | ||
| * Executes the given command synchronously. | ||
| * | ||
| * @param command The command to execute. | ||
| * @param callback Receives code and output asynchronously. | ||
| */ | ||
| (command: string, callback: ExecCallback): child.ChildProcess; | ||
| } | ||
@@ -835,152 +835,152 @@ | ||
| export type ExecCallback = ( | ||
| /** The process exit code. */ | ||
| code: number, | ||
| /** The process exit code. */ | ||
| code: number, | ||
| /** The process standard output. */ | ||
| stdout: string, | ||
| /** The process standard output. */ | ||
| stdout: string, | ||
| /** The process standard error output. */ | ||
| stderr: string | ||
| /** The process standard error output. */ | ||
| stderr: string | ||
| ) => any; | ||
| export interface ExecOptions extends child.ExecOptions { | ||
| /** | ||
| * Do not echo program output to the console. | ||
| * | ||
| * @default false | ||
| */ | ||
| silent?: boolean; | ||
| /** | ||
| * Do not echo program output to the console. | ||
| * | ||
| * @default false | ||
| */ | ||
| silent?: boolean; | ||
| /** | ||
| * Exit when command return code is non-zero. | ||
| * | ||
| * @default false | ||
| */ | ||
| fatal?: boolean; | ||
| /** | ||
| * Exit when command return code is non-zero. | ||
| * | ||
| * @default false | ||
| */ | ||
| fatal?: boolean; | ||
| /** | ||
| * Asynchronous execution. | ||
| * | ||
| * If a callback is provided, it will be set to `true`, regardless of the passed value. | ||
| * | ||
| * @default false | ||
| */ | ||
| async?: boolean; | ||
| /** | ||
| * Asynchronous execution. | ||
| * | ||
| * If a callback is provided, it will be set to `true`, regardless of the passed value. | ||
| * | ||
| * @default false | ||
| */ | ||
| async?: boolean; | ||
| /** | ||
| * Character encoding to use. | ||
| * | ||
| * Affects the values returned by `stdout` and `stderr`, | ||
| * and what is written to `stdout` and `stderr` when not in silent mode | ||
| * | ||
| * @default "utf8" | ||
| */ | ||
| encoding?: string; | ||
| /** | ||
| * Character encoding to use. | ||
| * | ||
| * Affects the values returned by `stdout` and `stderr`, | ||
| * and what is written to `stdout` and `stderr` when not in silent mode | ||
| * | ||
| * @default "utf8" | ||
| */ | ||
| encoding?: string; | ||
| } | ||
| export interface ExecOutputReturnValue { | ||
| /** The process exit code. */ | ||
| code: number; | ||
| /** The process exit code. */ | ||
| code: number; | ||
| /** The process standard output. */ | ||
| stdout: string; | ||
| /** The process standard output. */ | ||
| stdout: string; | ||
| /** The process standard error output. */ | ||
| stderr: string; | ||
| /** The process standard error output. */ | ||
| stderr: string; | ||
| } | ||
| export interface ShellReturnValue extends ExecOutputReturnValue { | ||
| /** | ||
| * 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 file The file to use. | ||
| */ | ||
| to(file: string): void; | ||
| /** | ||
| * 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 file The file to use. | ||
| */ | ||
| 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 file The file to append to. | ||
| */ | ||
| toEnd(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 file The file to append to. | ||
| */ | ||
| toEnd(file: string): void; | ||
| /** | ||
| * Returns a string containing the given pipeline, or a concatenated string | ||
| * containing the pipelines if more than one input stream is given | ||
| * (a new line character is introduced between each input). | ||
| * | ||
| * @return A string containing the given pipeline, or a concatenated string | ||
| * containing the pipelines if more than one input stream is given | ||
| * (a new line character is introduced between each input). | ||
| */ | ||
| cat: CatFunction; | ||
| /** | ||
| * Returns a string containing the given pipeline, or a concatenated string | ||
| * containing the pipelines if more than one input stream is given | ||
| * (a new line character is introduced between each input). | ||
| * | ||
| * @return A string containing the given pipeline, or a concatenated string | ||
| * containing the pipelines if more than one input stream is given | ||
| * (a new line character is introduced between each input). | ||
| */ | ||
| cat: CatFunction; | ||
| /** | ||
| * Executes the given command. | ||
| * | ||
| * @param command The command to execute. | ||
| * @param options Silence and synchronous options. | ||
| * @param [callback] Receives code and output asynchronously. | ||
| * @return Returns an object containing the return code and output as string, | ||
| * or if `{async: true}` or a `callback` was passed, a `ChildProcess`. | ||
| */ | ||
| exec: ExecFunction; | ||
| /** | ||
| * Executes the given command. | ||
| * | ||
| * @param command The command to execute. | ||
| * @param options Silence and synchronous options. | ||
| * @param [callback] Receives code and output asynchronously. | ||
| * @return Returns an object containing the return code and output as string, | ||
| * or if `{async: true}` or a `callback` was passed, a `ChildProcess`. | ||
| */ | ||
| exec: ExecFunction; | ||
| /** | ||
| * Read the start of a pipeline input. | ||
| */ | ||
| head: HeadFunction; | ||
| /** | ||
| * Read the start of a pipeline input. | ||
| */ | ||
| head: HeadFunction; | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-v`: Inverse the sense of the regex and print | ||
| * the lines not matching the criteria. | ||
| * - `-l`: Print only filenames of matching files | ||
| * @param regex_filter The regular expression to use. | ||
| * @return Returns a string containing all lines of the file that match the given `regex_filter`. | ||
| */ | ||
| grep: GrepFunction; | ||
| /** | ||
| * 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 options Available options: | ||
| * - `-v`: Inverse the sense of the regex and print | ||
| * the lines not matching the criteria. | ||
| * - `-l`: Print only filenames of matching files | ||
| * @param regex_filter The regular expression to use. | ||
| * @return Returns a string containing all lines of the file that match the given `regex_filter`. | ||
| */ | ||
| grep: GrepFunction; | ||
| /** | ||
| * Reads an input string from pipeline and performs a JavaScript `replace()` | ||
| * on the input using the given search regex and replacement string or function. | ||
| * | ||
| * @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. | ||
| * @return The new string after replacement. | ||
| */ | ||
| sed: SedFunction; | ||
| /** | ||
| * Reads an input string from pipeline and performs a JavaScript `replace()` | ||
| * on the input using the given search regex and replacement string or function. | ||
| * | ||
| * @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. | ||
| * @return The new string after replacement. | ||
| */ | ||
| sed: SedFunction; | ||
| /** | ||
| * Return the contents of the pipeline, sorted line-by-line. | ||
| * | ||
| * @param options Available options: | ||
| * - `-r`: Reverse the results | ||
| * - `-n`: Compare according to numerical value | ||
| */ | ||
| sort: SortFunction; | ||
| /** | ||
| * Return the contents of the pipeline, sorted line-by-line. | ||
| * | ||
| * @param options Available options: | ||
| * - `-r`: Reverse the results | ||
| * - `-n`: Compare according to numerical value | ||
| */ | ||
| sort: SortFunction; | ||
| /** | ||
| * Read the end of a pipeline input. | ||
| */ | ||
| tail: TailFunction; | ||
| /** | ||
| * Read the end of a pipeline input. | ||
| */ | ||
| tail: TailFunction; | ||
| /** | ||
| * Filter adjacent matching lines from input. | ||
| * | ||
| * @param options Available options: | ||
| * - `-i`: Ignore case while comparing | ||
| * - `-c`: Prefix lines by the number of occurrences | ||
| * - `-d`: Only print duplicate lines, one for each group of identical lines | ||
| */ | ||
| uniq: UniqFunction; | ||
| /** | ||
| * Filter adjacent matching lines from input. | ||
| * | ||
| * @param options Available options: | ||
| * - `-i`: Ignore case while comparing | ||
| * - `-c`: Prefix lines by the number of occurrences | ||
| * - `-d`: Only print duplicate lines, one for each group of identical lines | ||
| */ | ||
| uniq: UniqFunction; | ||
| } | ||
@@ -993,42 +993,42 @@ | ||
| export interface ShellStringConstructor { | ||
| /** | ||
| * Wraps a string (or array) value. This has all the string (or array) methods, | ||
| * but also exposes extra methods: `.to()`, `.toEnd()`, and all the pipe-able | ||
| * methods (ex. `.cat()`, `.grep()`, etc.). | ||
| * | ||
| * This can be easily converted into a string by calling `.toString()`. | ||
| * | ||
| * This type also exposes the corresponding command's stdout, stderr, and return status | ||
| * code via the `.stdout` (string), `.stderr` (string), and `.code` (number) properties | ||
| * respectively. | ||
| * | ||
| * Construct signature allows for: | ||
| * | ||
| * var foo = new ShellString('hello world'); | ||
| * | ||
| * as per example in shelljs docs: | ||
| * https://github.com/shelljs/shelljs#shellstringstr | ||
| * | ||
| * @param value The string value to wrap. | ||
| * @return A string-like object with special methods. | ||
| */ | ||
| new(value: string): ShellString; | ||
| new(value: string[]): ShellArray; | ||
| /** | ||
| * Wraps a string (or array) value. This has all the string (or array) methods, | ||
| * but also exposes extra methods: `.to()`, `.toEnd()`, and all the pipe-able | ||
| * methods (ex. `.cat()`, `.grep()`, etc.). | ||
| * | ||
| * This can be easily converted into a string by calling `.toString()`. | ||
| * | ||
| * This type also exposes the corresponding command's stdout, stderr, and return status | ||
| * code via the `.stdout` (string), `.stderr` (string), and `.code` (number) properties | ||
| * respectively. | ||
| * | ||
| * Construct signature allows for: | ||
| * | ||
| * var foo = new ShellString('hello world'); | ||
| * | ||
| * as per example in shelljs docs: | ||
| * https://github.com/shelljs/shelljs#shellstringstr | ||
| * | ||
| * @param value The string value to wrap. | ||
| * @return A string-like object with special methods. | ||
| */ | ||
| new(value: string): ShellString; | ||
| new(value: string[]): ShellArray; | ||
| /** | ||
| * Wraps a string (or array) value. This has all the string (or array) methods, | ||
| * but also exposes extra methods: `.to()`, `.toEnd()`, and all the pipe-able | ||
| * methods (ex. `.cat()`, `.grep()`, etc.). | ||
| * | ||
| * This can be easily converted into a string by calling `.toString()`. | ||
| * | ||
| * This type also exposes the corresponding command's stdout, stderr, and return status | ||
| * code via the `.stdout` (string), `.stderr` (string), and `.code` (number) properties | ||
| * respectively. | ||
| * | ||
| * @param value The string value to wrap. | ||
| * @return A string-like object with special methods. | ||
| */ | ||
| (value: string): ShellString; | ||
| (value: string[]): ShellArray; | ||
| /** | ||
| * Wraps a string (or array) value. This has all the string (or array) methods, | ||
| * but also exposes extra methods: `.to()`, `.toEnd()`, and all the pipe-able | ||
| * methods (ex. `.cat()`, `.grep()`, etc.). | ||
| * | ||
| * This can be easily converted into a string by calling `.toString()`. | ||
| * | ||
| * This type also exposes the corresponding command's stdout, stderr, and return status | ||
| * code via the `.stdout` (string), `.stderr` (string), and `.code` (number) properties | ||
| * respectively. | ||
| * | ||
| * @param value The string value to wrap. | ||
| * @return A string-like object with special methods. | ||
| */ | ||
| (value: string): ShellString; | ||
| (value: string[]): ShellArray; | ||
| } | ||
@@ -1039,37 +1039,37 @@ | ||
| export interface ChmodFunction { | ||
| /** | ||
| * Alters the permissions of a file or directory by either specifying the absolute | ||
| * permissions in octal form or expressing the changes in symbols. | ||
| * | ||
| * This command tries to mimic the POSIX behavior as much as possible. | ||
| * | ||
| * Notable exceptions: | ||
| * - In symbolic modes, 'a-r' and '-r' are identical. No consideration is given to the umask. | ||
| * - There is no "quiet" option since default behavior is to run silent. | ||
| * | ||
| * @param options Available options: | ||
| * - `-v`: output a diagnostic for every file processed | ||
| * - `-c`: like -v but report only when a change is made | ||
| * - `-R`: change files and directories recursively | ||
| * @param mode The access mode. Can be an octal string or a symbolic mode string. | ||
| * @param file The file to use. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, mode: string | number, file: string): ShellString; | ||
| /** | ||
| * Alters the permissions of a file or directory by either specifying the absolute | ||
| * permissions in octal form or expressing the changes in symbols. | ||
| * | ||
| * This command tries to mimic the POSIX behavior as much as possible. | ||
| * | ||
| * Notable exceptions: | ||
| * - In symbolic modes, 'a-r' and '-r' are identical. No consideration is given to the umask. | ||
| * - There is no "quiet" option since default behavior is to run silent. | ||
| * | ||
| * @param options Available options: | ||
| * - `-v`: output a diagnostic for every file processed | ||
| * - `-c`: like -v but report only when a change is made | ||
| * - `-R`: change files and directories recursively | ||
| * @param mode The access mode. Can be an octal string or a symbolic mode string. | ||
| * @param file The file to use. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (options: string, mode: string | number, file: string): ShellString; | ||
| /** | ||
| * Alters the permissions of a file or directory by either specifying the absolute | ||
| * permissions in octal form or expressing the changes in symbols. | ||
| * | ||
| * This command tries to mimic the POSIX behavior as much as possible. | ||
| * | ||
| * Notable exceptions: | ||
| * - In symbolic modes, 'a-r' and '-r' are identical. No consideration is given to the umask. | ||
| * - There is no "quiet" option since default behavior is to run silent. | ||
| * | ||
| * @param mode The access mode. Can be an octal string or a symbolic mode string. | ||
| * @param file The file to use. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (mode: string | number, file: string): ShellString; | ||
| /** | ||
| * Alters the permissions of a file or directory by either specifying the absolute | ||
| * permissions in octal form or expressing the changes in symbols. | ||
| * | ||
| * This command tries to mimic the POSIX behavior as much as possible. | ||
| * | ||
| * Notable exceptions: | ||
| * - In symbolic modes, 'a-r' and '-r' are identical. No consideration is given to the umask. | ||
| * - There is no "quiet" option since default behavior is to run silent. | ||
| * | ||
| * @param mode The access mode. Can be an octal string or a symbolic mode string. | ||
| * @param file The file to use. | ||
| * @return Object with shell exit code, stderr and stdout. | ||
| */ | ||
| (mode: string | number, file: string): ShellString; | ||
| } | ||
@@ -1117,18 +1117,18 @@ | ||
| export interface TouchOptionsArray { | ||
| "-d"?: string; | ||
| "-r"?: string; | ||
| "-d"?: string; | ||
| "-r"?: string; | ||
| } | ||
| export interface TouchFunction { | ||
| ( | ||
| options: TouchOptionsLiteral | TouchOptionsArray, | ||
| files: string[] | ||
| ): ShellString; | ||
| ( | ||
| options: TouchOptionsLiteral | TouchOptionsArray, | ||
| ...files: string[] | ||
| ): ShellString; | ||
| ( | ||
| options: TouchOptionsLiteral | TouchOptionsArray, | ||
| files: string[] | ||
| ): ShellString; | ||
| ( | ||
| options: TouchOptionsLiteral | TouchOptionsArray, | ||
| ...files: string[] | ||
| ): ShellString; | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| } | ||
@@ -1143,12 +1143,12 @@ | ||
| export interface HeadOptions { | ||
| /** Show the first <num> lines of the files. */ | ||
| "-n": number; | ||
| /** Show the first <num> lines of the files. */ | ||
| "-n": number; | ||
| } | ||
| export interface HeadFunction { | ||
| (options: HeadOptions, files: string[]): ShellString; | ||
| (options: HeadOptions, ...files: string[]): ShellString; | ||
| (options: HeadOptions, files: string[]): ShellString; | ||
| (options: HeadOptions, ...files: string[]): ShellString; | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| } | ||
@@ -1162,19 +1162,19 @@ | ||
| export interface SortFunction { | ||
| /** | ||
| * Return the contents of the files, sorted line-by-line. | ||
| * Sorting multiple files mixes their content (just as unix sort does). | ||
| * | ||
| * @param options Available options: | ||
| * - `-r`: Reverse the results | ||
| * - `-n`: Compare according to numerical value | ||
| */ | ||
| (options: string, files: string[]): ShellString; | ||
| (options: string, ...files: string[]): ShellString; | ||
| /** | ||
| * Return the contents of the files, sorted line-by-line. | ||
| * Sorting multiple files mixes their content (just as unix sort does). | ||
| * | ||
| * @param options Available options: | ||
| * - `-r`: Reverse the results | ||
| * - `-n`: Compare according to numerical value | ||
| */ | ||
| (options: string, files: string[]): ShellString; | ||
| (options: string, ...files: string[]): ShellString; | ||
| /** | ||
| * Return the contents of the files, sorted line-by-line. | ||
| * Sorting multiple files mixes their content (just as unix sort does). | ||
| */ | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| /** | ||
| * Return the contents of the files, sorted line-by-line. | ||
| * Sorting multiple files mixes their content (just as unix sort does). | ||
| */ | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| } | ||
@@ -1193,12 +1193,12 @@ | ||
| export interface TailOptions { | ||
| /** Show the last <num> lines of files. */ | ||
| "-n": number; | ||
| /** Show the last <num> lines of files. */ | ||
| "-n": number; | ||
| } | ||
| export interface TailFunction { | ||
| (options: TailOptions, files: string[]): ShellString; | ||
| (options: TailOptions, ...files: string[]): ShellString; | ||
| (options: TailOptions, files: string[]): ShellString; | ||
| (options: TailOptions, ...files: string[]): ShellString; | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| (files: string[]): ShellString; | ||
| (...files: string[]): ShellString; | ||
| } | ||
@@ -1212,16 +1212,16 @@ | ||
| export interface UniqFunction { | ||
| /** | ||
| * Filter adjacent matching lines from input. | ||
| * | ||
| * @param options Available options: | ||
| * - `-i`: Ignore case while comparing | ||
| * - `-c`: Prefix lines by the number of occurrences | ||
| * - `-d`: Only print duplicate lines, one for each group of identical lines | ||
| */ | ||
| (options: string, input: string, output?: string): ShellString; | ||
| /** | ||
| * Filter adjacent matching lines from input. | ||
| * | ||
| * @param options Available options: | ||
| * - `-i`: Ignore case while comparing | ||
| * - `-c`: Prefix lines by the number of occurrences | ||
| * - `-d`: Only print duplicate lines, one for each group of identical lines | ||
| */ | ||
| (options: string, input: string, output?: string): ShellString; | ||
| /** | ||
| * Filter adjacent matching lines from input. | ||
| */ | ||
| (input: string, output?: string): ShellString; | ||
| /** | ||
| * Filter adjacent matching lines from input. | ||
| */ | ||
| (input: string, output?: string): ShellString; | ||
| } | ||
@@ -1251,33 +1251,33 @@ | ||
| export interface ShellConfig { | ||
| /** | ||
| * Suppresses all command output if true, except for echo() calls. Default is false. | ||
| */ | ||
| silent: boolean; | ||
| /** | ||
| * Suppresses all command output if true, except for echo() calls. Default is false. | ||
| */ | ||
| silent: boolean; | ||
| /** | ||
| * If true the script will die on errors. Default is false. | ||
| */ | ||
| fatal: boolean; | ||
| /** | ||
| * If true the script will die on errors. Default is false. | ||
| */ | ||
| fatal: boolean; | ||
| /** | ||
| * Will print each executed command to the screen. | ||
| * | ||
| * @default false | ||
| */ | ||
| verbose: boolean; | ||
| /** | ||
| * Will print each executed command to the screen. | ||
| * | ||
| * @default false | ||
| */ | ||
| verbose: boolean; | ||
| /** | ||
| * Passed to glob.sync() instead of the default options ({}). | ||
| */ | ||
| globOptions: glob.IOptions; | ||
| /** | ||
| * Passed to glob.sync() instead of the default options ({}). | ||
| */ | ||
| globOptions: glob.IOptions; | ||
| /** | ||
| * Absolute path of the Node binary. Default is null (inferred). | ||
| */ | ||
| execPath: string | null; | ||
| /** | ||
| * Absolute path of the Node binary. Default is null (inferred). | ||
| */ | ||
| execPath: string | null; | ||
| /** | ||
| * Reset shell.config to the defaults. | ||
| */ | ||
| reset(): void; | ||
| /** | ||
| * Reset shell.config to the defaults. | ||
| */ | ||
| reset(): void; | ||
| } | ||
@@ -1284,0 +1284,0 @@ |
| import shelljs = require('./index'); | ||
| declare global { | ||
| interface Target { | ||
| (...args: any[]): void; | ||
| result?: any; | ||
| done?: boolean; | ||
| } | ||
| const target: { | ||
| all?: Target; | ||
| [s: string]: Target; | ||
| }; | ||
| interface Target { | ||
| (...args: any[]): void; | ||
| result?: any; | ||
| done?: boolean; | ||
| } | ||
| const target: { | ||
| all?: Target; | ||
| [s: string]: Target; | ||
| }; | ||
| const cat: typeof shelljs.cat; | ||
| const cd: typeof shelljs.cd; | ||
| const chmod: typeof shelljs.chmod; | ||
| const config: typeof shelljs.config; | ||
| const cp: typeof shelljs.cp; | ||
| const dirs: typeof shelljs.dirs; | ||
| const echo: typeof shelljs.echo; | ||
| const env: typeof shelljs.env; | ||
| const error: typeof shelljs.error; | ||
| const exec: typeof shelljs.exec; | ||
| const exit: typeof shelljs.exit; | ||
| const find: typeof shelljs.find; | ||
| const grep: typeof shelljs.grep; | ||
| const head: typeof shelljs.head; | ||
| const ln: typeof shelljs.ln; | ||
| const ls: typeof shelljs.ls; | ||
| const mkdir: typeof shelljs.mkdir; | ||
| const mv: typeof shelljs.mv; | ||
| const popd: typeof shelljs.popd; | ||
| const pushd: typeof shelljs.pushd; | ||
| const pwd: typeof shelljs.pwd; | ||
| const rm: typeof shelljs.rm; | ||
| const sed: typeof shelljs.sed; | ||
| const set: typeof shelljs.set; | ||
| const sort: typeof shelljs.sort; | ||
| const tail: typeof shelljs.tail; | ||
| const tempdir: typeof shelljs.tempdir; | ||
| const touch: typeof shelljs.touch; | ||
| const uniq: typeof shelljs.uniq; | ||
| const ShellString: typeof shelljs.ShellString; | ||
| const cat: typeof shelljs.cat; | ||
| const cd: typeof shelljs.cd; | ||
| const chmod: typeof shelljs.chmod; | ||
| const config: typeof shelljs.config; | ||
| const cp: typeof shelljs.cp; | ||
| const dirs: typeof shelljs.dirs; | ||
| const echo: typeof shelljs.echo; | ||
| const env: typeof shelljs.env; | ||
| const error: typeof shelljs.error; | ||
| const exec: typeof shelljs.exec; | ||
| const exit: typeof shelljs.exit; | ||
| const find: typeof shelljs.find; | ||
| const grep: typeof shelljs.grep; | ||
| const head: typeof shelljs.head; | ||
| const ln: typeof shelljs.ln; | ||
| const ls: typeof shelljs.ls; | ||
| const mkdir: typeof shelljs.mkdir; | ||
| const mv: typeof shelljs.mv; | ||
| const popd: typeof shelljs.popd; | ||
| const pushd: typeof shelljs.pushd; | ||
| const pwd: typeof shelljs.pwd; | ||
| const rm: typeof shelljs.rm; | ||
| const sed: typeof shelljs.sed; | ||
| const set: typeof shelljs.set; | ||
| const sort: typeof shelljs.sort; | ||
| const tail: typeof shelljs.tail; | ||
| const tempdir: typeof shelljs.tempdir; | ||
| const touch: typeof shelljs.touch; | ||
| const uniq: typeof shelljs.uniq; | ||
| const ShellString: typeof shelljs.ShellString; | ||
| } |
| { | ||
| "name": "@types/shelljs", | ||
| "version": "0.8.7", | ||
| "version": "0.8.8", | ||
| "description": "TypeScript definitions for ShellJS", | ||
@@ -55,4 +55,4 @@ "license": "MIT", | ||
| }, | ||
| "typesPublisherContentHash": "db89ff690359f102f594922e4c2588d4b8dfa81caceb39f025933764922a7866", | ||
| "typeScriptVersion": "2.8" | ||
| "typesPublisherContentHash": "d3e31bb2d56e81dcbb413d9ebf074d2fe4bde1f463d038ebbe40461f9258d922", | ||
| "typeScriptVersion": "3.0" | ||
| } |
@@ -11,3 +11,3 @@ # Installation | ||
| ### Additional Details | ||
| * Last updated: Sun, 22 Mar 2020 21:07:04 GMT | ||
| * Last updated: Fri, 15 May 2020 13:12:37 GMT | ||
| * Dependencies: [@types/glob](https://npmjs.com/package/@types/glob), [@types/node](https://npmjs.com/package/@types/node) | ||
@@ -14,0 +14,0 @@ * Global values: none |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by5.23%
50085
No dependency changes