https://github.com/queckezz/get-windows-env
Get a list of system or user environment variables on windows
https://github.com/queckezz/get-windows-env
Last synced: 7 months ago
JSON representation
Get a list of system or user environment variables on windows
- Host: GitHub
- URL: https://github.com/queckezz/get-windows-env
- Owner: queckezz
- License: mit
- Created: 2015-11-16T15:44:40.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-11-17T18:49:56.000Z (almost 10 years ago)
- Last Synced: 2025-03-06T10:02:53.700Z (7 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# get-windows-env
[![Build Status][travis-image]][travis-url]
[![NPM version][version-image]][version-url]
[![Dependency Status][david-image]][david-url]
[![License][license-image]][license-url]
[![Js Standard Style][standard-image]][standard-url]
Get a list of system or user environment variables on windows.
## Why not just `process.env`?
If you want to differentiate between user and system variables this package is for you. Otherwise `process.env` works just fine.
## Example
See [test/index.js](./test/index.js) for full examples.
```js
import {
getUserEnv,
getSystemEnv
} from 'get-windows-env'
getSystemEnv().then(registry => console.log(registry))
/* =>
* [
* {
* name: 'TEMP',
* type: 'REG_EXPAND_SZ',
* path: '%USERPROFILE%\\AppData\\Local\\Temp'
* },
* {
* name: 'TMP',
* type: 'REG_EXPAND_SZ',
* path: '%USERPROFILE%\\AppData\\Local\\Temp'
* },
*
* ...
* ]
*/
```
## API
#### `#getUserEnv()`
Gets all user environment variables.
#### `#getSystemEnv()`
Gets all system environment variables.
#### `#queryRegistry(key)`
Given a registry key, it returns you a string with registry entries, matching that path.
#### `#parseRegistry(registry::String)`
Parses a given registry string from the `queryRegistry()` function to a set of key value pairs `{ name, type, path }`.
```js
const keys = parseRegistry(queryRegistry(SOME_KEY))
```
#### `#keys`
Object containing `{ user, system }` registry keys for querying the windows registry.
#### Tests
```bash
$ npm test
```
## License
[MIT][license-url]
[travis-image]: https://img.shields.io/travis/queckezz/get-windows-env.svg?style=flat-square
[travis-url]: https://travis-ci.org/queckezz/get-windows-env
[version-image]: https://img.shields.io/npm/v/get-windows-env.svg?style=flat-square
[version-url]: https://npmjs.org/package/get-windows-env
[david-image]: http://img.shields.io/david/queckezz/get-windows-env.svg?style=flat-square
[david-url]: https://david-dm.org/queckezz/get-windows-env
[standard-image]: https://img.shields.io/badge/code-standard-brightgreen.svg?style=flat-square
[standard-url]: https://github.com/feross/standard
[license-image]: http://img.shields.io/npm/l/get-windows-env.svg?style=flat-square
[license-url]: ./license