polystore 0.15.10 → 0.15.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/index.d.ts +14 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "polystore",
3
- "version": "0.15.10",
3
+ "version": "0.15.11",
4
4
  "description": "A small compatibility layer for many popular KV stores like localStorage, Redis, FileSystem, etc.",
5
5
  "homepage": "https://polystore.dev/",
6
6
  "repository": "https://github.com/franciscop/polystore.git",
package/src/index.d.ts CHANGED
@@ -193,4 +193,17 @@ export interface Store {
193
193
  };
194
194
  }
195
195
 
196
- export default function (store?: any): Store;
196
+ /**
197
+ * Create a Store instance with the given client:
198
+ *
199
+ * ```js
200
+ * import kv from "polystore";
201
+ * const store1 = kv(new Map());
202
+ * const store2 = kv(localStorage);
203
+ * const store3 = kv(redisClient);
204
+ * const store4 = kv(yourOwnStore);
205
+ * ```
206
+ *
207
+ * **[→ Full kv() Docs](https://polystore.dev/documentation)**
208
+ */
209
+ export default function (client?: any): Store;