diff --git a/package.json b/package.json index 1509abe..e58a8bd 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "save" ], "dependencies": { - "conf": "^6.0.0", + "conf": "^6.2.0", "type-fest": "^0.7.1" }, "devDependencies": { diff --git a/readme.md b/readme.md index 1683f89..6b0e8cd 100644 --- a/readme.md +++ b/readme.md @@ -101,9 +101,11 @@ store.set('foo', '1'); 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 `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). Example: @@ -113,14 +115,17 @@ const Store = require('electron-store'); const store = new Store({ migrations: { '0.0.1': store => { - store.set('debug phase', true); + store.set('debugPhase', true); }, '1.0.0': store => { - store.delete('debug phase'); - store.set('phase', '1.0'); + store.delete('debugPhase'); + store.set('phase', '1.0.0'); }, '1.0.2': store => { - store.set('phase', '>1.0'); + store.set('phase', '1.0.2'); + }, + '>=2.0.0': store => { + store.set('phase', '>=2.0.0'); } } });