npm-run-path
- Version 6.0.0
- Published
- 8.64 kB
- 2 dependencies
- MIT license
Install
npm i npm-run-path
yarn add npm-run-path
pnpm add npm-run-path
Overview
Get your PATH prepended with locally installed binaries
Index
Functions
Type Aliases
Functions
function npmRunPath
npmRunPath: (options?: RunPathOptions) => string;
Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries.
Returns
The augmented path string.
Example 1
import childProcess from 'node:child_process';import {npmRunPath} from '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'
function npmRunPathEnv
npmRunPathEnv: (options?: EnvOptions) => ProcessEnv;
Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries.
Returns
The augmented [
process.env
](https://nodejs.org/api/process.html#process_process_env) object.Example 1
import childProcess from 'node:child_process';import {npmRunPathEnv} from 'npm-run-path';// `foo` is a locally installed binarychildProcess.execFileSync('foo', {env: npmRunPathEnv()});
Type Aliases
type CommonOptions
type CommonOptions = { /** Working directory.
@default process.cwd() */ readonly cwd?: string | URL;
/** The path to the current Node.js executable.
This can be either an absolute path or a path relative to the `cwd` option.
@default [process.execPath](https://nodejs.org/api/process.html#processexecpath) */ readonly execPath?: string | URL;
/** Whether to push the current Node.js executable's directory (`execPath` option) to the front of PATH.
@default true */ readonly addExecPath?: boolean;
/** Whether to push the locally installed binaries' directory to the front of PATH.
@default true */ readonly preferLocal?: boolean;};
type EnvOptions
type EnvOptions = CommonOptions & { /** 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.
@default [process.env](https://nodejs.org/api/process.html#processenv) */ readonly env?: ProcessEnv;};
type ProcessEnv
type ProcessEnv = Record<string, string | undefined>;
type RunPathOptions
type RunPathOptions = CommonOptions & { /** PATH to be appended.
Set it to an empty string to exclude the default PATH.
@default [`PATH`](https://github.com/sindresorhus/path-key) */ readonly path?: string;};
Package Files (1)
Dependencies (2)
Dev Dependencies (3)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/npm-run-path
.
- Markdown[](https://www.jsdocs.io/package/npm-run-path)
- HTML<a href="https://www.jsdocs.io/package/npm-run-path"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3362 ms. - Missing or incorrect documentation? Open an issue for this package.