{"_id":"@bratel/registry-js","name":"@bratel/registry-js","dist-tags":{"latest":"1.17.0"},"versions":{"1.17.0":{"name":"@bratel/registry-js","version":"1.17.0","description":"A simple and opinionated library for working with the Windows registry","main":"dist/lib/index.js","typings":"dist/lib/index.d.ts","scripts":{"install":"prebuild-install","build":"tsc","pretest":"yarn build","test":"jest -c jest.json","prepublishOnly":"yarn build && yarn test","postpublish":"git push --follow-tags","benchmark":"ts-node benchmarks/reg.ts","prettier":"yarn prettier --write","check-prettier":"prettier --check \"./**/*.{ts,tsx,js,json,jsx,scss,html,yaml,yml}\"","prebuild-napi-x64":"prebuild -t 3 -r napi -a x64 --strip","prebuild-napi-ia32":"prebuild -t 3 -r napi -a ia32 --strip","prebuild-napi-arm64":"prebuild -t 3 -r napi -a arm64 --strip","prebuild-all":"yarn prebuild-napi-x64 && yarn prebuild-napi-ia32 && yarn prebuild-napi-arm64","upload":"node ./script/upload.js"},"repository":{"type":"git","url":"git+https://github.com/lsq/registry-js.git"},"keywords":[],"author":"","license":"MIT","bugs":{"url":"https://github.com/lsq/registry-js/issues"},"homepage":"https://github.com/lsq/registry-js#readme","devDependencies":{"@bratel/prebuild":"^14.0.4","@types/benchmark":"^1.0.31","@types/jest":"^26.0.13","@types/node":"^22.10.9","benchmark":"^2.1.4","jest":"^26.4.2","node-abi":"^4.9.0","node-gyp":"^11.2.0","prettier":"^3.8.1","ts-node":"^9.0.0","typescript":"^5.8.2"},"dependencies":{"node-addon-api":"^8.3.1","@bratel/prebuild-install":"^8.0.0"},"binary":{"napi_versions":[3]},"config":{"runtime":"napi","target":3},"_id":"@bratel/registry-js@1.17.0","_integrity":"sha512-wpJyPAUjcgT5D8pkQfUURb0ionlcMPLQGpC65sn5J73EEt33jLvbHz8+XaIUZC099DB8BPRuz1Bo/tEQai1VDw==","_resolved":"D:\\a\\registry-js\\registry-js\\bratel-registry-js-1.17.0.tgz","_from":"file:bratel-registry-js-1.17.0.tgz","_nodeVersion":"24.14.0","_npmVersion":"11.9.0","dist":{"integrity":"sha512-wpJyPAUjcgT5D8pkQfUURb0ionlcMPLQGpC65sn5J73EEt33jLvbHz8+XaIUZC099DB8BPRuz1Bo/tEQai1VDw==","shasum":"e4dff8529320b4d1d8089e2aa592d431b9afa609","tarball":"https://registry.npmjs.org/@bratel/registry-js/-/registry-js-1.17.0.tgz","fileCount":18,"unpackedSize":884389,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFjysZEH/YT53LrkOYjPEIibwqqOny5vokVa+/2EihxNAiBbunWJQmtip2ciXBDd2sfFyoOacA5YSpQSjZkbg11IZw=="}]},"_npmUser":{"name":"honeyratel","email":"lsqypj@gmail.com"},"directories":{},"maintainers":[{"name":"honeyratel","email":"lsqypj@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/registry-js_1.17.0_1775441332085_0.03526062926854223"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-06T02:08:52.008Z","1.17.0":"2026-04-06T02:08:52.318Z","modified":"2026-04-06T02:08:52.542Z"},"maintainers":[{"name":"honeyratel","email":"lsqypj@gmail.com"}],"description":"A simple and opinionated library for working with the Windows registry","homepage":"https://github.com/lsq/registry-js#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/lsq/registry-js.git"},"bugs":{"url":"https://github.com/lsq/registry-js/issues"},"license":"MIT","readme":"# registry-js\r\n\r\n## A simple and opinionated library for working with the Windows registry\r\n\r\n## Goals\r\n\r\n* zero dependencies\r\n* faster than `reg.exe`\r\n* implement based on usage - don't replicate the registry API\r\n* leverage TypeScript declarations wherever possible\r\n\r\n**Note:** This is currently in preview, with support for features that GitHub\r\nDesktop and Atom require.\r\n\r\n## Install \r\n\r\n```shellsession\r\n$ npm install --save registry-js\r\n# or\r\n$ yarn add registry-js\r\n```\r\n\r\n## But Why?\r\n\r\nThe current set of libraries for interacting with the registry have some\r\nlimitations that meant we couldn't use it in GitHub Desktop:\r\n\r\n* [`windows-registry`](https://www.npmjs.com/package/windows-registry) depends\r\n  on `ffi` at runtime, which caused issues with webpack-ing, and was missing\r\n  APIs we needed.\r\n* [`winreg`](https://www.npmjs.com/package/winreg) depends on\r\n  `reg.exe` which breaks as soon as you enable \"Prevent access to registry\r\n  editing tools\" Group Policy rules (yes, even `QUERY` operations are caught by\r\n  this). More details about this can be found in\r\n  [desktop/desktop#3105](https://github.com/desktop/desktop/issues/3105).\r\n\r\nAfter exploring other options like invoking PowerShell - which was too slow - we\r\ndecided to write our own little library to do the stuff we require by invoking\r\nthe Win32 APIs directly.\r\n\r\n## Documentation\r\n\r\nSee the documentation under the\r\n[`docs`](https://github.com/desktop/registry-js/tree/master/docs) folder.\r\n\r\n## Supported versions\r\n\r\nEach release of `registry-js` includes prebuilt binaries for the versions of\r\nNode and Electron that are actively supported by these projects. Please refer\r\nto the release documentation for [Node](https://github.com/nodejs/Release) and\r\n[Electron](https://electronjs.org/docs/tutorial/support) to see what is\r\nsupported currently.\r\n\r\n## Contributing\r\n\r\nRead the [Setup](https://github.com/desktop/registry-js/blob/master/docs/index.md#setup)\r\nsection to ensure your development environment is setup for what you need.\r\n\r\nThis project isn't about implementing a 1-1 replication of the Windows registry\r\nAPI, but implementing just enough for whatever usages there are in the wild.\r\n\r\nIf you want to see something supported, open an issue to start a discussion\r\nabout it.\r\n","readmeFilename":"README.md","_rev":"1-6f572558840d61b170d5887f801f3450"}