Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fresc81/node-winreg
node module that provides access to the Windows Registry through the REG commandline tool
https://github.com/fresc81/node-winreg
Last synced: 3 months ago
JSON representation
node module that provides access to the Windows Registry through the REG commandline tool
- Host: GitHub
- URL: https://github.com/fresc81/node-winreg
- Owner: fresc81
- Created: 2013-04-19T08:50:10.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-06T21:21:04.000Z (3 months ago)
- Last Synced: 2024-04-14T05:58:45.241Z (3 months ago)
- Language: JavaScript
- Size: 757 KB
- Stars: 207
- Watchers: 5
- Forks: 58
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Lists
- awesome-cross-platform-nodejs - node-winreg - Access the Windows registry. (Libraries / Windows registry)
- awesome-nodejs-pure-js - node-winreg
README
[](https://nodei.co/npm/winreg/)
[](https://gitter.im/fresc81/node-winreg?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# node-winreg #
node module that provides access to the Windows Registry through the REG commandline tool
## Installation ##
The following command installs node-winreg.
```shell
npm install winreg
```
If you prefer to install _without the development tools used to generate the HTML documentation_ (into a production environment for example) you should use the following command.
```shell
npm install winreg --production
```
Note that the development dependencies will not be installed if this package was installed as a dependency of another package.
## Documentation ##
The documentation is generated using [jsdoc](http://github.com/jsdoc3/jsdoc "jsdoc Website") with the [docstrap template](http://docstrap.github.io/docstrap "docstrap website"). You can view the API documentation [online](http://fresc81.github.io/node-winreg "online documentation"), download the latest documentation or generate it from the sourcecode.
### Online Documentation ###
View the latest docs [online](http://fresc81.github.io/node-winreg "online documentation").
### Download Documentation ###
To download the latest docs from GIT the following command is used.
```shell
npm run-script download-docs
```
### Generate Documentation ###
To generate the docs from the sources you can use the following command.
```shell
npm run-script generate-docs
```
Note that generating the docs requires the development dependencies to be installed.
## Example Usage ##
Let's start with an example. The code below lists the autostart programs of the current user.
```javascript
var Registry = require('winreg')
, regKey = new Registry({ // new operator is optional
hive: Registry.HKCU, // open registry hive HKEY_CURRENT_USER
key: '\\Software\\Microsoft\\Windows\\CurrentVersion\\Run' // key containing autostart programs
})
// list autostart programs
regKey.values(function (err, items /* array of RegistryItem */) {
if (err)
console.log('ERROR: '+err);
else
for (var i=0; ichcp (w/o parameters). To set a new codepage (UTF-8 for this example) you pass the codepage number as the only argument to chcp. The codepage value for UTF-8 is 65001.
You can easily do this from within your nodejs script by using the child_process.execSync(...) function like the following example shows.
```javascript
var execSync = require('child_process').execSync;
console.log(execSync('chcp').toString());
console.log(execSync('chcp 65001').toString());
```
An even better approach would be to extract and store the value returned by a call to chcp prior setting the console to UTF-8 and resetting the codepage after your script is done.
## License ##
This project is released under [BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause).
Copyright (c) 2016, Paul Bottin All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.