electron-store
Advanced tools
electron-store - npm Package Compare versions
Comparing version 3.3.0 to 4.0.0
| { | ||
| "name": "electron-store", | ||
| "version": "3.3.0", | ||
| "version": "4.0.0", | ||
| "description": "Simple data persistence for your Electron app or module - Save and load user preferences, app state, cache, etc", | ||
@@ -36,8 +36,8 @@ "license": "MIT", | ||
| "dependencies": { | ||
| "conf": "^4.1.0", | ||
| "type-fest": "^0.3.1" | ||
| "conf": "^5.0.0", | ||
| "type-fest": "^0.5.2" | ||
| }, | ||
| "devDependencies": { | ||
| "ava": "^1.4.1", | ||
| "electron": "^4.1.4", | ||
| "ava": "^2.1.0", | ||
| "electron": "^5.0.5", | ||
| "execa": "^1.0.0", | ||
@@ -44,0 +44,0 @@ "tsd": "^0.7.2", |
@@ -16,3 +16,3 @@ # electron-store [](https://travis-ci.org/sindresorhus/electron-store) | ||
| *Requires Electron 4 or later.* | ||
| *Requires Electron 5 or later.* | ||
@@ -45,3 +45,3 @@ | ||
| ### Store([options]) | ||
| ### Store(options?) | ||
@@ -52,7 +52,7 @@ Returns a new instance. | ||
| Type: `Object` | ||
| Type: `object` | ||
| #### defaults | ||
| Type: `Object` | ||
| Type: `object` | ||
@@ -65,3 +65,3 @@ Default values for the store items. | ||
| type: `Object` | ||
| type: `object` | ||
@@ -123,8 +123,8 @@ [JSON Schema](https://json-schema.org) to validate your config data. | ||
| Type: `string` `Buffer` `TypedArray` `DataView`<br> | ||
| Type: `string | Buffer | TypedArray | DataView`<br> | ||
| Default: `undefined` | ||
| Note that this is **not intended for security purposes**, since the encryption key would be easily found inside a plain-text Electron app. | ||
| This can be used to secure sensitive data **if** the encryption key is stored in a secure manner (not plain-text) in the Node.js app. For example, by using [`node-keytar`](https://github.com/atom/node-keytar) to store the encryption key securely, or asking the encryption key from the user (a password) and then storing it in a variable. | ||
| Its main use is for obscurity. If a user looks through the config directory and finds the config file, since it's just a JSON file, they may be tempted to modify it. By providing an encryption key, the file will be obfuscated, which should hopefully deter any users from doing so. | ||
| In addition to security, this could be used for obscurity. If a user looks through the config directory and finds the config file, since it's just a JSON file, they may be tempted to modify it. By providing an encryption key, the file will be obfuscated, which should hopefully deter any users from doing so. | ||
@@ -131,0 +131,0 @@ It also has the added bonus of ensuring the config file's integrity. If the file is changed in any way, the decryption will not work, in which case the store will just reset back to its default state. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.65%
13887
Dependency changes
+ Addedconf@5.0.0(transitive)
+ Addedtype-fest@0.5.2(transitive)
- Removedconf@4.1.0(transitive)
- Removedtype-fest@0.3.1(transitive)
Updatedconf@^5.0.0
Updatedtype-fest@^0.5.2