saiwolf / reg-file-parser

Welcome to reg-file-parser 👋

What is this?

A library written in typescript that parses Windows Registry export files (.reg).

This project started life as a direct porting of Henryk Filipowicz's Registry Export File Parser which is written in C#; but it has evolved since; though the principals remain the same.

Add to your project

npm

npm install reg-file-parser

yarn

yarn add reg-file-parser

Quickstart

Parse a registry file

// CommonJS
const regParser = require('reg-file-parser');
const result = new regParser.RegFileObject('./relative/path/to/file.reg');
// do something with `result`

// ESModule
import { RegFileObject} from 'reg-file-parser';

const result = new RegFileObject('./relative/path/to/file.reg');
// do something with `result`

All interfaces are public. You can use them to type your code as needed.

Docs

Docs are generated with TypeDoc

https://saiwolf.github.io/reg-file-parser/

Author

👤 Robert Cato [e-mail]

• Website: https://keybase.io/saiwolf
• Github: @saiwolf

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 Robert Cato [e-mail].
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator