electron-store

Breaking

• Require Node.js 20 and Electron 30 7ddf0c6
• This package is now pure ESM. Please read this and this.

https://github.com/sindresorhus/electron-store/compare/v8.2.0...v9.0.0

• Allow awaiting .openInEditor() (#272) c0bcdb7

https://github.com/sindresorhus/electron-store/compare/v8.1.0...v8.2.0

• Add beforeEachMigration option 26df5b3

https://github.com/sindresorhus/electron-store/compare/v8.0.2...v8.1.0

• Fix Options type parameter constraint for TS 4.7 (#223) e3fae8e

https://github.com/sindresorhus/electron-store/compare/v8.0.1...v8.0.2

• Upgrade conf patch version 77a674f
  • To force the latest version of ajv: https://github.com/sindresorhus/conf/commit/f19ee6bfb0e6b189d17d7af7be255bd4c8345c1b#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519L45-R46

https://github.com/sindresorhus/electron-store/compare/v8.0.0...v8.0.1

Breaking

• Upgrade to from Ajv 7 to Ajv 8

https://github.com/sindresorhus/electron-store/compare/v7.0.3...v8.0.0

• Fix the internal IPC to only subscribe to events once (#180) cbe1449

https://github.com/sindresorhus/electron-store/compare/v7.0.2...v7.0.3

• Improve error message when user forgot to call Store.initRenderer() (#166) a61f9ea

https://github.com/sindresorhus/electron-store/compare/v7.0.1...v7.0.2

• Fix the TypeScript type for initRenderer 05a769d

https://github.com/sindresorhus/electron-store/compare/v7.0.0...v7.0.1

Breaking

• Require Electron 11 7beffc1
  • It will most likely still work on Electron 9 and up, but I'm not interested in providing support for versions older than Electron 11.
• Make the clearInvalidConfig option false by default 76efa82
• Fix compatibility with Electron 12 (and remove use of electron.remote) (#157) 191ae04
  • If you create a store that is imported into both the main and renderer process, you don't have to do anything. If you only create a store in the renderer process, you need to manually call Store.initRenderer() in the main process.
• Update ajv to version 7. This might affect you if you're using the schema option.

https://github.com/sindresorhus/electron-store/compare/v6.0.1...v7.0.0

• Fix the migration feature (#143) dced818
  Turns out it never worked properly...

https://github.com/sindresorhus/electron-store/compare/v6.0.0...v6.0.1

Breaking

• Require Electron 7 and later a066c03
  This is the oldest version supported by the Electron team.

Improvements

• Upgrade conf dependency b29a67e
  This fixes a file writing problem on Windows.

https://github.com/sindresorhus/electron-store/compare/v5.2.0...v6.0.0

• Improve Electron 9 compatibility (#119) 5e644eb

https://github.com/sindresorhus/electron-store/compare/v5.1.1...v5.2.0

• Improve docs 03efcb5 f88a646 6d7157c

https://github.com/sindresorhus/electron-store/compare/v5.1.0...v5.1.1

• Warning: The migrations option is buggy. Don't use it at this time.
• Add semver range capabilities into migrations https://github.com/sindresorhus/conf/commit/df3a2569fdedeb7c199bb840b7903f86760e028e

https://github.com/sindresorhus/electron-store/compare/v5.0.0...v5.1.0

Breaking for TypeScript users

• Improve TypeScript typings https://github.com/sindresorhus/conf/commit/ef63b113e31adc3a8a09facd582de5b140320aa5 https://github.com/sindresorhus/conf/commit/ff5495254eb33998d1f8863f38616f130045dcf5
  The types were made much better, but it will probably break for some users. You can now properly define a strongly-typed store. Example.
  Note: There's no way to use a dot-path like store.get('foo.bar') with a typed store. We're looking into how to support that: https://github.com/sindresorhus/conf/issues/86

Enhancements

• Add support for migrations https://github.com/sindresorhus/conf/commit/931ffce6bc653b7395ad52224b3c9c3e312d1045

Fixes

• Add temporary workaround for electron-store being packaged in a Snap app https://github.com/sindresorhus/conf/commit/68bbb4609b0e1abde84e38937376b1fc5f90f131

https://github.com/sindresorhus/electron-store/compare/v4.0.0...v5.0.0

Breaking:

• Require Electron 5 0540766

Enhancements:

• Fix deprecated crypto.createDecipher() and crypto.createCipher() Node.js warnings (#72) 8261b92
  Node.js deprecated the above APIs and we had to do encryption for the encryptionKey option differently. electron-store should be able to read both the new and old encryption format and it will write the new encryption format if you change any config. The migration is fully automatic, but please test your app thoroughly in case there are any issues.

https://github.com/sindresorhus/electron-store/compare/v3.3.0...v4.0.0

Enhancements:

• Add accessPropertiesByDotNotation option 0dd4164
• Add .onDidAnyChange() method 0dd4164

https://github.com/sindresorhus/electron-store/compare/v3.2.0...v3.3.0

• Add TypeScript definition (#61) b2630c0

https://github.com/sindresorhus/electron-store/compare/v3.1.0...v3.2.0

• Add support for JSON schema https://github.com/sindresorhus/conf/commit/373afb9826365d522a1fb2fa9d0dd49a995e4703
• Fix issue when used in a sandboxed Mac App Store app and the user has a package.json file in their home directory https://github.com/sindresorhus/electron-store/issues/59 https://github.com/sindresorhus/conf/commit/bb26c4f0a64cd8f1868eda2883cea651f0462fc0

https://github.com/sindresorhus/electron-store/compare/v3.0.0...v3.1.0