2023-12-03 16:59:28 +04:00
# path-key [![Build Status](https://travis-ci.org/sindresorhus/path-key.svg?branch=master)](https://travis-ci.org/sindresorhus/path-key)
> Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform
It's usually `PATH` , but on Windows it can be any casing like `Path` ...
## Install
```
2024-01-06 20:33:49 +04:00
$ npm install path-key
2023-12-03 16:59:28 +04:00
```
## Usage
```js
const pathKey = require('path-key');
const key = pathKey();
//=> 'PATH'
const PATH = process.env[key];
//=> '/usr/local/bin:/usr/bin:/bin'
```
## API
2024-01-06 20:33:49 +04:00
### pathKey(options?)
2023-12-03 16:59:28 +04:00
#### options
2024-01-06 20:33:49 +04:00
Type: `object`
2023-12-03 16:59:28 +04:00
##### env
2024-01-06 20:33:49 +04:00
Type: `object` < br >
2023-12-03 16:59:28 +04:00
Default: [`process.env` ](https://nodejs.org/api/process.html#process_process_env )
Use a custom environment variables object.
#### platform
Type: `string` < br >
Default: [`process.platform` ](https://nodejs.org/api/process.html#process_process_platform )
Get the PATH key for a specific platform.
2024-01-06 20:33:49 +04:00
---
2023-12-03 16:59:28 +04:00
2024-01-06 20:33:49 +04:00
< div align = "center" >
< b >
< a href = "https://tidelift.com/subscription/pkg/npm-path-key?utm_source=npm-path-key&utm_medium=referral&utm_campaign=readme" > Get professional support for this package with a Tidelift subscription< / a >
< / b >
< br >
< sub >
Tidelift helps make open source sustainable for maintainers while giving companies< br > assurances about security, maintenance, and licensing for their dependencies.
< / sub >
< / div >