* Bump @ava/typescript from 3.0.1 to 4.0.0 Bumps [@ava/typescript](https://github.com/avajs/typescript) from 3.0.1 to 4.0.0. - [Release notes](https://github.com/avajs/typescript/releases) - [Commits](https://github.com/avajs/typescript/compare/v3.0.1...v4.0.0) --- updated-dependencies: - dependency-name: "@ava/typescript" dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Update checked-in dependencies --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions@github.com>
31 lines
730 B
TypeScript
31 lines
730 B
TypeScript
export interface Options {
|
|
/**
|
|
Use a custom environment variables object.
|
|
|
|
Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env).
|
|
*/
|
|
readonly env?: Record<string, string | undefined>;
|
|
|
|
/**
|
|
Get the PATH key for a specific platform.
|
|
|
|
Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform).
|
|
*/
|
|
readonly platform?: NodeJS.Platform;
|
|
}
|
|
|
|
/**
|
|
Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform.
|
|
|
|
@example
|
|
```
|
|
import pathKey from 'path-key';
|
|
|
|
const key = pathKey();
|
|
//=> 'PATH'
|
|
|
|
const PATH = process.env[key];
|
|
//=> '/usr/local/bin:/usr/bin:/bin'
|
|
```
|
|
*/
|
|
export default function pathKey(options?: Options): string;
|