windows-registry0.1.5 • Public • Published
Read and Write to the Windows registry in-process from Node.js. Easily set application file associations and launch processes as an Administrator.
This library interacts with native Windows APIs. To add this module to your Node application, install the package:
npm install windows-registry
To install node modules that require compilation on Windows, make sure you have installed the necessary build tools. Specifically, we need
npm install -g node-gyp, a cross-platform cli written in Node.js for native addon modules for Node.js.
node-gyp, install python v2.7.3 and Visual Studio 2013 build tools. You do not need to install the full Visual Studio, only the build tools are required. Once the build tools are installed, you should be able to do
npm install -g node-gyp.
Creating File Associations
To create a file association, you can call the
fileAssociation.associateExeForFile API, which will make windows assign a default program for an arbitrary file extension:
var utils = utils;utils;
After running the code above, you will see files with the extension of
.zzz will be automatically associated with the Node program and their file icon will be changed to the Node file icon.
Reading and Writing to the Windows Registry
This library implements only a few of the basic registry commands, which allow you to do basic CRUD operations for keys in the registry.
Opening a Registry Key
Registry keys can be opened by either opening a predefined registry key defined in the windef module:
var Key = Key;var key = windefHKEYHKEY_CLASSES_ROOT '.txt' windefKEY_ACCESSKEY_ALL_ACCESS;
Or you can open a sub key from an already opened key:
var Key = Key;var key = windefHKEYHKEY_CLASSES_ROOT '' windefKEY_ACCESSKEY_ALL_ACCESS;var key2 = key;
And don't forget to close your key when you're done. Otherwise, you will leak native resources:
Creating a Key
var Key = Key;// predefined keyvar key = windefHKEYHKEY_CLASSES_ROOT '' windefKEY_ACCESSKEY_ALL_ACCESS;var createdKey = key;
Deleting a Key
To delete a key just call the
Writing a Value to a Key
To write a value, you will again need a Key object and just need to call the
var Key = Keywindef = windef;var key = windefHKEYHKEY_CLASSES_ROOT '.txt' windefKEY_ACCESSKEY_ALL_ACCESS;key;
Get a Value From a Key
To get a value from a key, just call
var value = key;
The return value depends on the type of the key (REG_SZ for example will give you a string).
Launching a Process as an Admin
To launch a process as an Administrator, you can call the
utils.elevate API, which will launch a process as an Administrator causing the UAC (User Account Control) elevation prompt to appear if required. This is similar to the Windows Explorer command "Run as administrator". Pass in
FILEPATH to the process you want to elevate. Pass in any
PARAMETERS to run with the process. Since this is an asynchronous call, pass in a callback to handle user's selection.
var utils = utils;utils;
The process you want to launch with admin access will only be launched after the callback is called and only if the user clicks Yes in the UAC prompt. Otherwise, the process will not be launched. If the user is already running as an admin, the UAC prompt will not be triggered and the process you provided will be launched as an administrator automatically.
Make your way over to the tests section to see how the module can be used.