polystore 0.12.1 → 0.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polystore",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "description": "A small compatibility layer for many popular KV stores like localStorage, Redis, FileSystem, etc.",
   "homepage": "https://polystore.dev/",
   "repository": "https://github.com/franciscop/polystore.git",
@@ -17,7 +17,8 @@
     "size": "echo $(gzip -c src/index.js | wc -c) bytes",
     "lint": "check-dts test/index.types.ts",
     "start": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch --coverage --detectOpenHandles",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --ci --watchAll=false --detectOpenHandles"
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --ci --watchAll=false --detectOpenHandles",
+    "db": "etcd"
   },
   "keywords": [
     "kv",

package/readme.md

@@ -1,4 +1,4 @@
-# Polystore [![npm install polystore](https://img.shields.io/badge/npm%20install-polystore-blue.svg)](https://www.npmjs.com/package/polystore) [![test badge](https://github.com/franciscop/polystore/workflows/tests/badge.svg "test badge")](https://github.com/franciscop/polystore/blob/master/.github/workflows/tests.yml) [![gzip size](https://badgen.net/bundlephobia/minzip/polystore?label=gzip&color=green)](https://github.com/franciscop/polystore/blob/master/src/index.js)
+# Polystore [![npm install polystore](https://img.shields.io/badge/npm%20install-polystore-blue.svg)](https://www.npmjs.com/package/polystore) [![test badge](https://github.com/franciscop/polystore/workflows/tests/badge.svg "test badge")](https://github.com/franciscop/polystore/blob/master/.github/workflows/tests.yml) [![gzip size](https://badgen.net/bundlephobia/minzip/polystore?label=gzip&color=green)](https://bundlephobia.com/package/polystore)
 
 A key-value library to unify the API of [many clients](#clients), like localStorage, Redis, FileSystem, etc:
 
@@ -354,7 +354,7 @@ const sessions = Object.fromEntries(sessionEntries);
 
 ### .clear()
 
-Remove all of the data from the store:
+Remove all of the data from the store and resets it to the original state:
 
 ```js
 await store.clear();

package/src/index.js

@@ -1,5 +1,5 @@
 import clients from "./clients/index.js";
-import { createId, isClass, parse } from "./utils.js";
+import { createId, isClass, parse, unix } from "./utils.js";
 
 class Store {
   PREFIX = "";
@@ -42,18 +42,13 @@ class Store {
       for (let method of ["has", "keys", "values"]) {
         if (client[method]) {
           throw new Error(
-            `You can only define client.${method}() when the client manages the expiration; otherwise please do NOT define .${method}() and let us manage it`
+            `You can only define client.${method}() when the client manages the expiration; otherwise please do NOT define .${method}() and let us manage it`,
           );
         }
       }
     }
   }
 
-  #unix(expires) {
-    const now = new Date().getTime();
-    return expires === null ? null : now + expires * 1000;
-  }
-
   // Check if the given data is fresh or not; if
   #isFresh(data, key) {
     // Should never happen, but COULD happen; schedule it for
@@ -76,30 +71,29 @@ class Store {
 
   async add(value, options = {}) {
     await this.promise;
-    const expires = parse(options.expire ?? options.expires);
+    let expires = parse(options.expire ?? options.expires);
 
     // Use the underlying one from the client if found
     if (this.client.add) {
       if (this.client.EXPIRES) {
-        return this.client.add(this.PREFIX, value, { expires });
+        return await this.client.add(this.PREFIX, value, { expires });
       }
 
       // In the data we need the timestamp since we need it "absolute":
-      return this.client.add(this.PREFIX, {
-        expires: this.#unix(expires),
-        value,
-      });
+      expires = unix(expires);
+      const key = await this.client.add(this.PREFIX, { expires, value });
+      return key;
     }
 
-    const id = createId();
-    await this.set(id, value, { expires });
-    return id; // The plain one without the prefix
+    const key = createId();
+    await this.set(key, value, { expires });
+    return key; // The plain one without the prefix
   }
 
   async set(key, value, options = {}) {
     await this.promise;
     const id = this.PREFIX + key;
-    const expires = parse(options.expire ?? options.expires);
+    let expires = parse(options.expire ?? options.expires);
 
     // Quick delete
     if (value === null || (typeof expires === "number" && expires <= 0)) {
@@ -114,7 +108,8 @@ class Store {
     }
 
     // In the data we need the timestamp since we need it "absolute":
-    await this.client.set(id, { expires: this.#unix(expires), value });
+    expires = unix(expires);
+    await this.client.set(id, { expires, value });
     return key;
   }
 
@@ -258,7 +253,7 @@ class Store {
 
   prefix(prefix = "") {
     const store = new Store(
-      Promise.resolve(this.promise).then((client) => client || this.client)
+      Promise.resolve(this.promise).then((client) => client || this.client),
     );
     store.PREFIX = this.PREFIX + prefix;
     return store;

package/src/utils.js

@@ -47,3 +47,8 @@ export function isClass(func) {
     /^class\s/.test(Function.prototype.toString.call(func))
   );
 }
+
+export function unix(expires) {
+  const now = new Date().getTime();
+  return expires === null ? null : now + expires * 1000;
+}