winreg

What is winreg?

The winreg npm package is a Node.js library for accessing and manipulating the Windows Registry. It allows you to read, write, and delete registry keys and values, making it useful for applications that need to interact with the Windows operating system at a low level.

What are winreg's main functionalities?

Read a registry key

This feature allows you to read a value from a specified registry key. The code sample demonstrates how to read a value named 'MyValue' from the 'HKEY_CURRENT_USER\Software\MyApp' key.

const Winreg = require('winreg');
const regKey = new Winreg({
  hive: Winreg.HKCU, // HKEY_CURRENT_USER
  key: '\Software\MyApp'
});
regKey.get('MyValue', (err, item) => {
  if (err) console.log('Error:', err);
  else console.log('Value:', item.value);
});

Write a registry key

This feature allows you to write a value to a specified registry key. The code sample demonstrates how to set a string value named 'MyValue' with the data 'MyData' in the 'HKEY_CURRENT_USER\Software\MyApp' key.

const Winreg = require('winreg');
const regKey = new Winreg({
  hive: Winreg.HKCU, // HKEY_CURRENT_USER
  key: '\Software\MyApp'
});
regKey.set('MyValue', Winreg.REG_SZ, 'MyData', (err) => {
  if (err) console.log('Error:', err);
  else console.log('Value written successfully');
});

Delete a registry key

This feature allows you to delete a value from a specified registry key. The code sample demonstrates how to remove a value named 'MyValue' from the 'HKEY_CURRENT_USER\Software\MyApp' key.

const Winreg = require('winreg');
const regKey = new Winreg({
  hive: Winreg.HKCU, // HKEY_CURRENT_USER
  key: '\Software\MyApp'
});
regKey.remove('MyValue', (err) => {
  if (err) console.log('Error:', err);
  else console.log('Value removed successfully');
});

Other packages similar to winreg

windows-registry

The windows-registry package is another alternative for interacting with the Windows Registry from Node.js. It provides basic functionality for reading and writing registry keys and values. While it is similar to winreg, it may not be as feature-rich or actively maintained.

README

node-winreg

node module that provides access to the Windows Registry through the REG commandline tool