path-key

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

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

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.}

Similar packages

Other packages similar to path-key

cross-env

The cross-env package allows you to set environment variables in a cross-platform way. While path-key is used to retrieve the PATH variable key, cross-env is used to set environment variables for scripts in a way that is compatible across different platforms.

which

The which package is a cross-platform implementation of the Unix 'which' command that finds the first instance of a specified executable in the PATH. It is similar to path-key in that it deals with system paths, but it serves a different purpose by locating executables rather than providing the PATH key.