chen.cheng 7498f5b8cc init 11 months ago
..
index.d.ts 7498f5b8cc init 11 months ago
index.js 7498f5b8cc init 11 months ago
license 7498f5b8cc init 11 months ago
package.json 7498f5b8cc init 11 months ago
readme.md 7498f5b8cc init 11 months ago

readme.md

path-key Build Status

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.