aboutsummaryrefslogtreecommitdiff
path: root/node_modules/npm-run-path/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/npm-run-path/index.d.ts')
-rw-r--r--node_modules/npm-run-path/index.d.ts89
1 files changed, 89 insertions, 0 deletions
diff --git a/node_modules/npm-run-path/index.d.ts b/node_modules/npm-run-path/index.d.ts
new file mode 100644
index 0000000..af10d41
--- /dev/null
+++ b/node_modules/npm-run-path/index.d.ts
@@ -0,0 +1,89 @@
+declare namespace npmRunPath {
+ interface RunPathOptions {
+ /**
+ Working directory.
+
+ @default process.cwd()
+ */
+ readonly cwd?: string;
+
+ /**
+ PATH to be appended. Default: [`PATH`](https://github.com/sindresorhus/path-key).
+
+ Set it to an empty string to exclude the default PATH.
+ */
+ readonly path?: string;
+
+ /**
+ Path to the Node.js executable to use in child processes if that is different from the current one. Its directory is pushed to the front of PATH.
+
+ This can be either an absolute path or a path relative to the `cwd` option.
+
+ @default process.execPath
+ */
+ readonly execPath?: string;
+ }
+
+ interface ProcessEnv {
+ [key: string]: string | undefined;
+ }
+
+ interface EnvOptions {
+ /**
+ Working directory.
+
+ @default process.cwd()
+ */
+ readonly cwd?: string;
+
+ /**
+ Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options.
+ */
+ readonly env?: ProcessEnv;
+
+ /**
+ Path to the current Node.js executable. Its directory is pushed to the front of PATH.
+
+ This can be either an absolute path or a path relative to the `cwd` option.
+
+ @default process.execPath
+ */
+ readonly execPath?: string;
+ }
+}
+
+declare const npmRunPath: {
+ /**
+ Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries.
+
+ @returns The augmented path string.
+
+ @example
+ ```
+ import * as childProcess from 'child_process';
+ import npmRunPath = require('npm-run-path');
+
+ console.log(process.env.PATH);
+ //=> '/usr/local/bin'
+
+ console.log(npmRunPath());
+ //=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin'
+
+ // `foo` is a locally installed binary
+ childProcess.execFileSync('foo', {
+ env: npmRunPath.env()
+ });
+ ```
+ */
+ (options?: npmRunPath.RunPathOptions): string;
+
+ /**
+ @returns The augmented [`process.env`](https://nodejs.org/api/process.html#process_process_env) object.
+ */
+ env(options?: npmRunPath.EnvOptions): npmRunPath.ProcessEnv;
+
+ // TODO: Remove this for the next major release
+ default: typeof npmRunPath;
+};
+
+export = npmRunPath;