polystore 0.9.0 → 0.9.2

package/assets/home.html

@@ -18,13 +18,15 @@
       >
     </div>
   </div>
-  <div style="width: 550px; max-width: 100%">
+  <div style="width: 570px; max-width: 100%">
     <pre><code class="language-js">import kv from &quot;polystore&quot;;
+import { createClient } from "redis";
 
-const store = kv(new Map());
+const REDIS = process.env.REDIS_URL;
+const store = kv(createClient(REDIS));
 
 await store.set(&quot;key1&quot;, { hello: &quot;world&quot; });
-const value = await store.get(&quot;key1&quot;);
+console.log(await store.get(&quot;key1&quot;));
 // { hello: &quot;world&quot; }</code></pre>
   </div>
 </section>
@@ -150,7 +152,7 @@ const value = await store.get(&quot;key1&quot;);
       <p>
         At
         <a href="https://bundlephobia.com/package/polystore" target="_blank"
-          >just <strong>2.4b</strong></a
+          >just <strong>2.4kb</strong></a
         >
         (min+gzip), the impact on your app loading time is minimal.
       </p>
@@ -304,16 +306,14 @@ console.log(await store.entries());
     </div>
   </div>
   <div>
-    <pre><code class="language-js">import kv from "polystore";
-const store = kv(new Map());
+    <pre><code class="language-js">await store.get("key");  // null
 
-const auth = store.prefix(&quot;auth:&quot;);
-auth.set(&quot;key1&quot;, &quot;value1&quot;);
-console.log(await auth.entries());
-// [[&quot;key1&quot;, &quot;value1&quot;]]
+await store.set("key", "value", { expires: "1s" });
+await store.get("key");  // "value"
 
-console.log(await store.entries());
-// [[&quot;auth:key1&quot;, &quot;value1&quot;]]</code></pre>
+await sleep(2000);
+
+await store.get("key");  // null</code></pre>
   </div>
 </section>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polystore",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "A small compatibility layer for many popular KV stores like localStorage, Redis, FileSystem, etc.",
   "homepage": "https://github.com/franciscop/polystore",
   "repository": "https://github.com/franciscop/polystore.git",

package/readme.md

@@ -67,6 +67,18 @@ const store = kv(MyClientOrStoreInstance);
 // use the store
 ```
 
+If the instance you pass contains a `connect()` or `open()` method, polystore **will** call that without any argument:
+
+```js
+// Simpler
+const store = kv(createClient());
+
+// NO NEED
+const client = createClient();
+client.connect();
+const store = kv(client);
+```
+
 While you can keep a reference to the store and access it directly, we strongly recommend if you are going to use a store, to only access it through `polystore`, since we do add custom serialization and extra properties for e.g. expiration time:
 
 ```js

package/src/index.js

@@ -32,14 +32,11 @@ class Store {
 
   constructor(clientPromise = new Map()) {
     this.promise = Promise.resolve(clientPromise).then(async (client) => {
-      this.client = getClient(client);
-      this.#validate(this.client);
-      if (this.client.open) {
-        await this.client.open();
-      }
-      if (this.client.connect) {
-        await this.client.connect();
-      }
+      if (client?.open) await client.open();
+      if (client?.connect) await client.connect();
+      client = getClient(client);
+      this.#validate(client);
+      this.client = client;
       this.promise = null;
       return client;
     });
@@ -309,10 +306,12 @@ class Store {
   }
 
   async close() {
+    await this.promise;
+
     if (this.client.close) {
       return this.client.close();
     }
   }
 }
 
-export default kv = (client) => new Store(client);
+export default (client) => new Store(client);

package/src/index.test.js

@@ -27,7 +27,7 @@ stores.push([`kv("cookie")`, kv("cookie")]);
 stores.push(["kv(new KVNamespace())", kv(new KVNamespace())]);
 stores.push([`kv(new Level("data"))`, kv(new Level("data"))]);
 if (process.env.REDIS) {
-  stores.push(["kv(redis)", kv(createClient().connect())]);
+  stores.push(["kv(redis)", kv(createClient())]);
 }
 if (process.env.ETCD) {
   stores.push(["kv(new Etcd3())", kv(new Etcd3())]);