README.md (1693B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # ENV 22 23 > Object containing the user environment. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var ENV = require( '@stdlib/process/env' ); 31 ``` 32 33 #### ENV 34 35 `Object` containing the user environment. 36 37 ```javascript 38 var user = ENV.USER; 39 // returns <string> 40 ``` 41 42 </section> 43 44 <!-- /.usage --> 45 46 <section class="notes"> 47 48 ## Notes 49 50 - See [environ(7)][man-environ]. 51 - Modifications to `ENV` are local to the process in which `ENV` is modified. 52 - On Windows systems, environment variables are case insensitive. 53 - In browser environments, `ENV` is an **empty** object. 54 - Be careful when modifying environment variables as the environment variable object represents shared state. Accordingly, modifications affect all environment variable consumers. 55 56 </section> 57 58 <!-- /.notes --> 59 60 <section class="examples"> 61 62 ## Examples 63 64 <!-- eslint no-undef: "error" --> 65 66 ```javascript 67 var ENV = require( '@stdlib/process/env' ); 68 69 console.dir( ENV ); 70 ``` 71 72 </section> 73 74 <!-- /.examples --> 75 76 <section class="links"> 77 78 [man-environ]: http://man7.org/linux/man-pages/man7/environ.7.html 79 80 </section> 81 82 <!-- /.links -->