@onlabsorg/stilo/test/test-repository/.stilo/node_modules/npm-run-path/index.d.ts

Command line tool for managing olojs document packages

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;
	}

	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;
	}
}

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;