mirror of https://github.com/deployphp/action.git synced 2024-11-23 12:29:03 +00:00

History

Anton Medvedev 2c2db8c641 Update action		2021-10-15 22:41:21 +02:00
..
index.d.ts	Add n_m	2020-11-10 23:12:02 +01:00
index.js	Add n_m	2020-11-10 23:12:02 +01:00
license	Add n_m	2020-11-10 23:12:02 +01:00
package.json	Update action	2021-10-15 22:41:21 +02:00
readme.md	Add n_m	2020-11-10 23:12:02 +01: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.}