You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
61 lines
1.3 KiB
61 lines
1.3 KiB
# path-key [](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 |
|
|
|
``` |
|
$ npm install path-key |
|
``` |
|
|
|
|
|
## Usage |
|
|
|
```js |
|
const pathKey = require('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`<br> |
|
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. |
|
|
|
|
|
--- |
|
|
|
<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>
|
|
|