# winreg-ffi

> A Node.js module for binding Winreg.h using node-ffi.

Latest version **0.0.5** (published 2015-11-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install winreg-ffi
pnpm add winreg-ffi
yarn add winreg-ffi
bun add winreg-ffi
```

Provides the command `winreg-ffi`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2015-11-18 |
| First published | 2015-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Masayuki Higashino |
| Maintainers | 61503891 |
| Keywords | windows, win32, registry, ffi |

## Links

- npm: https://www.npmjs.com/package/winreg-ffi
- Repository: https://github.com/mh61503891/node-winreg-ffi
- Homepage: https://github.com/mh61503891/node-winreg-ffi#readme
- Issues: https://github.com/mh61503891/node-winreg-ffi/issues
- npm.io page: https://npm.io/package/winreg-ffi

## Dependencies (6)

- [ffi](https://npm.io/package/ffi.md) ^2.0.0
- [ref](https://npm.io/package/ref.md) ^1.2.0
- [meow](https://npm.io/package/meow.md) ^3.6.0
- [jconv](https://npm.io/package/jconv.md) ^0.1.5
- [ref-struct](https://npm.io/package/ref-struct.md) ^1.0.2
- [coffee-script](https://npm.io/package/coffee-script.md) ^1.10.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2015-11-18
- 0.0.4 — 2015-11-18
- 0.0.3 — 2015-11-18
- 0.0.2 — 2015-11-15

## README

# winreg-ffi

A Node.js module for binding Winreg.h using [node-ffi](https://github.com/node-ffi/node-ffi).

## Example

```example.coffee
# written in CoffeeScript
Registry = require('winreg-ffi')

# keys
parent = 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall'
registry = Registry.open('HKLM', parent)
console.log keys = registry.keys()
registry.close()

# values
children = keys.map (key) -> parent + '\\' + key.name
registry = Registry.open('HKLM', children[5])
console.log registry.values()
registry.close()
```

## CLI

```
>winreg-ffi --help

A Node.js module for binding Winreg.h using node-ffi.

Usage:
  winreg-ffi --help
  winreg-ffi query KEY [--reg32 | --reg64]

Examples:
  winreg-ffi query HKLM\SOFTWARE
  winreg-ffi query HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\Office15.PROPLUS
```

## Development

### Test

```
npm test
```

or

```
set DEBUG=winreg-ffi:*
node_modules\.bin\mocha
```

### ToDo

- [x] RegOpenKeyExW `Registry.open()`
- [x] RegCloseKey `Registry.close()`
- [x] RegQueryInfoKey `Registry.info()`
- [x] RegEnumKeyExW `Registry.keys()`
- [x] RegEnumValueW `Registry.values()`
- [ ] RegQueryValueExW
- [ ] RegCreateKeyExW
- [ ] RegDeleteKeyW
- [ ] RegSetValueExW
- [ ] RegDeleteValueW
- [ ] RegFlushKey
- [x] CLI

## Author

- Masayuki Higashino

## License

The MIT License (MIT)

---
_Source: https://npm.io/package/winreg-ffi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._