https://github.com/sindresorhus/path-key

Get the PATH environment variable key cross-platform
https://github.com/sindresorhus/path-key

Last synced: about 1 month ago
JSON representation

Get the PATH environment variable key cross-platform

• Host: GitHub
• URL: https://github.com/sindresorhus/path-key
• Owner: sindresorhus
• License: mit
• Created: 2015-12-28T18:29:17.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2021-04-09T12:04:57.000Z (over 3 years ago)
• Last Synced: 2024-04-14T06:11:25.325Z (7 months ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 43
• Watchers: 5
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

README

        
# 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

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`](https://nodejs.org/api/process.html#process_process_env)

Use a custom environment variables object.

#### platform

Type: `string`\

Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform)

Get the PATH key for a specific platform.

---



	

		Get professional support for this package with a Tidelift subscription

	

	


	

		Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.