Skip to content

sindresorhus/path-key

path-key

Get the PATH environment variable key cross-platform

It's usually PATH but on Windows it can be any casing like Path...

Why?

While process.env.PATH reads correctly on Windows regardless of casing, you need the exact key when:

Install

npm install path-key

Usage

import pathKey from 'path-key';

const key = pathKey();
//=> 'PATH'

const PATH = process.env[key];
//=> '/usr/local/bin:/usr/bin:/bin'

API

pathKey(options?)

options

Type: object

env

Type: object
Default: process.env

Use a custom environment variables object.

platform

Type: string
Default: process.platform

Get the PATH key for a specific platform.

About

Get the PATH environment variable key cross-platform

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 6