✨ add global key factory option (#137)

* ✨ add factoryOptions key option * 📝 add global key docs

Author: prazdevs

docs/guide/advanced.md

@@ -31,6 +31,36 @@ Available global options include:
 Any option passed to a store's `persist` configuration will override its counterpart declared in the global options.
 :::
 
+## Global key option
+
+On top of other global persistence options, the `createPersistedState` factory function takes one more option: `key`. The global `key` option accepts a function that gets passed the store key and should return a string to become the new store key.
+
+```ts
+import { createPinia } from 'pinia'
+import { createPersistedState } from 'pinia-plugin-persistedstate'
+
+const pinia = createPinia()
+
+pinia.use(createPersistedState({
+ key: id => `__persisted__${id}`,
+}))
+```
+
+```ts
+import { defineStore } from 'pinia'
+
+defineStore('store', {
+ state: () => ({ saved : '' }),
+ persist: true,
+})
+```
+
+In this example, the store will be persisted under `__persisted__store` key instead of `store`.
+
+:::info
+This is option should be considered when you need to prefix/postfix all store keys globally.
+:::
+
 ## Multiple persistences per-store
 
 There may be specific use cases where you need to persist data from a single store to different storages. The `persist` option also accepts an array of configurations.

package.json

@@ -71,25 +71,25 @@
  },
  "devDependencies": {
  "@prazdevs/eslint-config-typescript": "^3.2.1",
- "@types/node": "^18.11.4",
- "@vitest/coverage-c8": "^0.24.3",
- "@vitest/ui": "^0.24.3",
+ "@types/node": "^18.11.9",
+ "@vitest/coverage-c8": "^0.24.5",
+ "@vitest/ui": "^0.24.5",
  "bumpp": "^8.2.1",
  "eslint": "8.26.0",
  "eslint-config-prettier": "^8.5.0",
  "eslint-plugin-prettier": "^4.2.1",
- "happy-dom": "^7.6.0",
+ "happy-dom": "^7.6.6",
  "husky": "^8.0.1",
  "lint-staged": "^13.0.3",
  "nuxt": "3.0.0-rc.12",
  "pinia": "^2.0.23",
  "prettier": "^2.7.1",
- "quasar": "^2.10.0",
+ "quasar": "^2.10.1",
  "tsup": "^6.3.0",
  "typescript": "^4.8.4",
- "vite": "^3.1.8",
- "vitepress": "1.0.0-alpha.22",
- "vitest": "^0.24.3",
+ "vite": "^3.2.2",
+ "vitepress": "1.0.0-alpha.26",
+ "vitest": "^0.24.5",
  "vue": "^3.2.41",
  "vue-demi": "^0.13.11",
  "vue2": "npm:vue@^2.7.5"