Blame view

node_modules/path-key/readme.md 967 Bytes
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
  # path-key [![Build Status](https://travis-ci.org/sindresorhus/path-key.svg?branch=master)](https://travis-ci.org/sindresorhus/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 --save path-key
  ```
  
  
  ## Usage
  
  ```js
  const pathKey = require('path-key');
  
  const key = pathKey();
  //=> 'PATH'
  
  const PATH = process.env[key];
  //=> '/usr/local/bin:/usr/bin:/bin'
  ```
  
  
  ## API
  
  ### pathKey([options])
  
  #### options
  
  ##### env
  
  Type: `Object`<br>
  Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env)
  
  Use a custom environment variables object.
  
  #### platform
  
  Type: `string`<br>
  Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform)
  
  Get the PATH key for a specific platform.
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)