Archived

This repository has been archived on 2022-01-16. You can view files and clone it, but cannot push or open issues or pull requests.

History

Rudis Muiznieks 1d7cc7ec9b switched from tslint to eslint		2021-09-04 22:21:14 -05:00
..
index.d.ts	switched from tslint to eslint	2021-09-04 22:21:14 -05:00
index.js	switched from tslint to eslint	2021-09-04 22:21:14 -05:00
license	switched from tslint to eslint	2021-09-04 22:21:14 -05:00
package.json	switched from tslint to eslint	2021-09-04 22:21:14 -05:00
readme.md	switched from tslint to eslint	2021-09-04 22:21:14 -05:00

readme.md

path-key

Get the PATH 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

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
Default: process.env

Use a custom environment variables object.

platform

Type: string
Default: 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.}