Improve docs

.travis.yml

@@ -2,5 +2,6 @@ os:
   - osx
 language: node_js
 node_js:
+  - '12'
   - '10'
   - '8'

license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package.json

@@ -4,10 +4,11 @@
 	"description": "Simple data persistence for your Electron app or module - Save and load user preferences, app state, cache, etc",
 	"license": "MIT",
 	"repository": "sindresorhus/electron-store",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -33,14 +34,14 @@
 		"save"
 	],
 	"dependencies": {
-		"conf": "^6.2.0",
+		"conf": "^6.2.1",
 		"type-fest": "^0.7.1"
 	},
 	"devDependencies": {
 		"ava": "^2.1.0",
 		"electron": "^6.0.7",
 		"execa": "^2.0.4",
-		"tsd": "^0.7.2",
+		"tsd": "^0.11.0",
 		"xo": "^0.24.0"
 	},
 	"xo": {

readme.md

@@ -6,7 +6,6 @@ Electron doesn't have a built-in way to persist user preferences and other data.
 
 You can use this module directly in both the main and renderer process.
 
-
 ## Install
 
 ```
@@ -15,7 +14,6 @@ $ npm install electron-store
 
 *Requires Electron 5 or later.*
 
-
 ## Usage
 
 ```js
@@ -37,7 +35,6 @@ console.log(store.get('unicorn'));
 //=> undefined
 ```
 
-
 ## API
 
 Changes are written to disk atomically, so if the process crashes during a write, it will not corrupt the existing config.
@@ -97,12 +94,10 @@ store.set('foo', '1');
 
 **Note:** The `default` value will be overwritten by the `defaults` option if set.
 
-### migrations
+#### migrations
 
 Type: `object`
 
-**Don't use this feature until [this issue](https://github.com/sindresorhus/conf/issues/92) has been fixed.**
-
 You can use migrations to perform operations to the store whenever a version is upgraded.
 
 The `migrations` object should consist of a key-value pair of `'version': handler`. The `version` can also be a [semver range](https://github.com/npm/node-semver#ranges).
@@ -131,18 +126,20 @@ const store = new Store({
 });
 ```
 
+> Note: The version the migrations use refers to the **project version** by default. If you want to change this behavior, specify the [`projectVersion`](#projectVersion) option.
+
 #### name
 
-Type: `string`<br>
-Default: `config`
+Type: `string`\
+Default: `'config'`
 
 Name of the storage file (without extension).
 
 This is useful if you want multiple storage files for your app. Or if you're making a reusable Electron module that persists some data, in which case you should **not** use the name `config`.
 
 #### cwd
 
-Type: `string`<br>
+Type: `string`\
 Default: [`app.getPath('userData')`](https://electronjs.org/docs/api/app#appgetpathname)
 
 Storage file location. *Don't specify this unless absolutely necessary! By default, it will pick the optimal location by adhering to system conventions. You are very likely to get this wrong and annoy users.*
@@ -151,7 +148,7 @@ If a relative path, it's relative to the default cwd. For example, `{cwd: 'unico
 
 #### encryptionKey
 
-Type: `string | Buffer | TypedArray | DataView`<br>
+Type: `string | Buffer | TypedArray | DataView`\
 Default: `undefined`
 
 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.
@@ -164,23 +161,23 @@ When specified, the store will be encrypted using the [`aes-256-cbc`](https://en
 
 #### fileExtension
 
-Type: `string`<br>
-Default: `json`
+Type: `string`\
+Default: `'json'`
 
 Extension of the config file.
 
 You would usually not need this, but could be useful if you want to interact with a file with a custom file extension that can be associated with your app. These might be simple save/export/preference files that are intended to be shareable or saved outside of the app.
 
 #### clearInvalidConfig
 
-Type: `boolean`<br>
+Type: `boolean`\
 Default: `true`
 
 The config is cleared if reading the config file causes a `SyntaxError`. This is a good default, as the config file is not intended to be hand-edited, so it usually means the config is corrupt and there's nothing the user can do about it anyway. However, if you let the user edit the config file directly, mistakes might happen and it could be more useful to throw an error when the config is invalid instead of clearing. Disabling this option will make it throw a `SyntaxError` on invalid config instead of clearing.
 
 #### serialize
 
-Type: `Function`<br>
+Type: `Function`\
 Default: `value => JSON.stringify(value, null, '\t')`
 
 Function to serialize the config object to a UTF-8 string when writing the config file.
@@ -189,7 +186,7 @@ You would usually not need this, but it could be useful if you want to use a for
 
 #### deserialize
 
-Type: `Function`<br>
+Type: `Function`\
 Default: `JSON.parse`
 
 Function to deserialize the config object from a UTF-8 string when reading the config file.
@@ -198,7 +195,7 @@ You would usually not need this, but it could be useful if you want to use a for
 
 #### accessPropertiesByDotNotation
 
-Type: `boolean`<br>
+Type: `boolean`\
 Default: `true`
 
 Accessing nested properties by dot notation. For example:
@@ -207,13 +204,15 @@ Accessing nested properties by dot notation. For example:
 const Store = require('electron-store');
 
 const store = new Store();
+
 store.set({
 	foo: {
 		bar: {
 			foobar: '🦄'
 		}
 	}
 });
+
 console.log(store.get('foo.bar.foobar'));
 //=> '🦄'
 ```
@@ -222,16 +221,18 @@ Alternatively, you can set this option to `false` so the whole string would be t
 
 ```js
 const store = new Store({accessPropertiesByDotNotation: false});
+
 store.set({
 	`foo.bar.foobar`: '🦄'
 });
+
 console.log(store.get('foo.bar.foobar'));
 //=> '🦄'
 ```
 
 #### watch
 
-Type: `boolean`<br>
+Type: `boolean`\
 Default: `false`
 
 Watch for any changes in the config file and call the callback for `onDidChange` if set. This is useful if there are multiple processes changing the same config file.
@@ -254,7 +255,7 @@ The `value` must be JSON serializable. Trying to set the type `undefined`, `func
 
 Set multiple items at once.
 
-#### .get(key, [defaultValue])
+#### .get(key, defaultValue?)
 
 Get an item or `defaultValue` if the item does not exist.
 
@@ -278,15 +279,35 @@ Delete all items.
 
 `callback`: `(newValue, oldValue) => {}`
 
-Watches the given `key`, calling `callback` on any changes. When a key is first set `oldValue` will be `undefined`, and when a key is deleted `newValue` will be `undefined`.
+Watches the given `key`, calling `callback` on any changes.
+
+When a key is first set `oldValue` will be `undefined`, and when a key is deleted `newValue` will be `undefined`.
 
 Events are only triggered in the same process. So you won't get events in the main process if you trigger an event in a renderer process. See [#39](https://github.com/sindresorhus/electron-store/issues/39).
 
+Returns a function which you can use to unsubscribe:
+
+```js
+const unsubscribe = store.onDidChange(key, callback);
+
+unsubscribe();
+```
+
 #### .onDidAnyChange(callback)
 
 `callback`: `(newValue, oldValue) => {}`
 
-Watches the whole config object, calling `callback` on any changes. `oldValue` and `newValue` will be the config object before and after the change, respectively. You must compare `oldValue` to `newValue` to find out what changed.
+Watches the whole config object, calling `callback` on any changes.
+
+`oldValue` and `newValue` will be the config object before and after the change, respectively. You must compare `oldValue` to `newValue` to find out what changed.
+
+Returns a function which you can use to unsubscribe:
+
+```js
+const unsubscribe = store.onDidAnyChange(key, callback);
+
+unsubscribe();
+```
 
 #### .size
 
@@ -297,7 +318,11 @@ Get the item count.
 Get all the data as an object or replace the current data with an object:
 
 ```js
-conf.store = {
+const Store = require('electron-store');
+
+const store = new Store();
+
+store.store = {
 	hello: 'world'
 };
 ```
@@ -310,12 +335,11 @@ Get the path to the storage file.
 
 Open the storage file in the user's editor.
 
-
 ## FAQ
 
-### [Advantages over `window.localStorage`](https://github.com/sindresorhus/electron-store/issues/17)
+#### [Advantages over `window.localStorage`](https://github.com/sindresorhus/electron-store/issues/17)
 
-### Can I use YAML or another serialization format?
+#### Can I use YAML or another serialization format?
 
 The `serialize` and `deserialize` options can be used to customize the format of the config file, as long as the representation is compatible with `utf8` encoding.
 
@@ -332,7 +356,6 @@ const store = new Store({
 });
 ```
 
-
 ## Related
 
 - [electron-util](https://github.com/sindresorhus/electron-util) - Useful utilities for developing Electron apps and modules
@@ -343,3 +366,4 @@ const store = new Store({
 - [electron-reloader](https://github.com/sindresorhus/electron-reloader) - Simple auto-reloading for Electron apps during development
 - [electron-serve](https://github.com/sindresorhus/electron-serve) - Static file serving for Electron apps
 - [conf](https://github.com/sindresorhus/conf) - Simple config handling for your app or module
+- [More…](https://github.com/search?q=user%3Asindresorhus+electron)