polystore 0.11.2 → 0.11.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polystore",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "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",

package/src/index.js

@@ -1,12 +1,6 @@
-/**
- * A number, or a string containing a number.
- * @typedef {(number|string|object|array)} Value
- */
-
 import clients from "./clients/index.js";
 import { createId, isClass, parse } from "./utils.js";
 
-// #region Store
 class Store {
   PREFIX = "";
 
@@ -21,7 +15,6 @@ class Store {
     });
   }
 
-  // #region #client()
   #find(store) {
     // Already a fully compliant KV store
     if (store instanceof Store) return store.client;
@@ -41,7 +34,6 @@ class Store {
     return store;
   }
 
-  // #region #validate()
   #validate(client) {
     if (!client.set || !client.get || !client.iterate) {
       throw new Error(
@@ -93,21 +85,6 @@ class Store {
     return false;
   }
 
-  // #region .add()
-  /**
-   * Save the data on an autogenerated key, can add expiration as well:
-   *
-   * ```js
-   * const key1 = await store.add("value1");
-   * const key2 = await store.add({ hello: "world" });
-   * const key3 = await store.add("value3", { expires: "1h" });
-   * ```
-   *
-   * **[→ Full .add() Docs](https://polystore.dev/documentation#add)**
-   * @param {Value} value
-   * @param {{ expires: string }} options
-   * @returns {Promise<string>}
-   */
   async add(value, options = {}) {
     await this.promise;
     const expires = parse(options.expire ?? options.expires);
@@ -130,22 +107,6 @@ class Store {
     return id; // The plain one without the prefix
   }
 
-  // #region .set()
-  /**
-   * Save the data on the given key, can add expiration as well:
-   *
-   * ```js
-   * const key = await store.set("key1", "value1");
-   * await store.set("key2", { hello: "world" });
-   * await store.set("key3", "value3", { expires: "1h" });
-   * ```
-   *
-   * **[→ Full .set() Docs](https://polystore.dev/documentation#set)**
-   * @param {string} key
-   * @param {Value} value
-   * @param {{ expires: string }} options
-   * @returns {Promise<string>}
-   */
   async set(key, value, options = {}) {
     await this.promise;
     const id = this.PREFIX + key;
@@ -168,23 +129,6 @@ class Store {
     return key;
   }
 
-  // #region .get()
-  /**
-   * Read a single value from the KV store:
-   *
-   * ```js
-   * const value1 = await store.get("key1");
-   * // null (doesn't exist or has expired)
-   * const value2 = await store.get("key2");
-   * // "value2"
-   * const value3 = await store.get("key3");
-   * // { hello: "world" }
-   * ```
-   *
-   * **[→ Full .get() Docs](https://polystore.dev/documentation#get)**
-   * @param {string} key
-   * @returns {Promise<Value>}
-   */
   async get(key) {
     await this.promise;
     const id = this.PREFIX + key;
@@ -202,26 +146,6 @@ class Store {
     return data.value;
   }
 
-  // #region .has()
-  /**
-   * Check whether a key exists or not:
-   *
-   * ```js
-   * if (await store.has("key1")) { ... }
-   * ```
-   *
-   * If you are going to use the value, it's better to just read it:
-   *
-   * ```js
-   * const val = await store.get("key1");
-   * if (val) { ... }
-   * ```
-   *
-   *
-   * **[→ Full .has() Docs](https://polystore.dev/documentation#has)**
-   * @param {string} key
-   * @returns {Promise<boolean>}
-   */
   async has(key) {
     await this.promise;
     const id = this.PREFIX + key;
@@ -234,18 +158,6 @@ class Store {
     return value !== null;
   }
 
-  // #region .del()
-  /**
-   * Remove a single key and its value from the store:
-   *
-   * ```js
-   * const key = await store.del("key1");
-   * ```
-   *
-   * **[→ Full .del() Docs](https://polystore.dev/documentation#del)**
-   * @param {string} key
-   * @returns {Promise<string>}
-   */
   async del(key) {
     await this.promise;
     const id = this.PREFIX + key;
@@ -272,33 +184,19 @@ class Store {
     }
   }
 
-  // #region .entries()
-  /**
-   * Return an array of the entries, in the [key, value] format:
-   *
-   * ```js
-   * const entries = await store.entries();
-   * // [["key1", "value1"], ["key2", { hello: "world" }], ...]
-   *
-   * // To limit it to a given prefix, use `.prefix()`:
-   * const sessions = await store.prefix("session:").entries();
-   * ```
-   *
-   * **[→ Full .entries() Docs](https://polystore.dev/documentation#entries)**
-   * @returns {Promise<[string, Value][]>}
-   */
   async entries() {
     await this.promise;
 
+    // Cut the key to size
+    const trim = (key) => key.slice(this.PREFIX.length);
+
     let list = [];
     if (this.client.entries) {
-      list = (await this.client.entries(this.PREFIX)).map(([key, value]) => [
-        key.slice(this.PREFIX.length),
-        value,
-      ]);
+      const entries = await this.client.entries(this.PREFIX);
+      list = entries.map(([key, value]) => [trim(key), value]);
     } else {
       for await (const [key, value] of this.client.iterate(this.PREFIX)) {
-        list.push([key.slice(this.PREFIX.length), value]);
+        list.push([trim(key), value]);
       }
     }
 
@@ -312,21 +210,6 @@ class Store {
       .map(([key, data]) => [key, data.value]);
   }
 
-  // #region .keys()
-  /**
-   * Return an array of the keys in the store:
-   *
-   * ```js
-   * const keys = await store.keys();
-   * // ["key1", "key2", ...]
-   *
-   * // To limit it to a given prefix, use `.prefix()`:
-   * const sessions = await store.prefix("session:").keys();
-   * ```
-   *
-   * **[→ Full .keys() Docs](https://polystore.dev/documentation#keys)**
-   * @returns {Promise<string[]>}
-   */
   async keys() {
     await this.promise;
 
@@ -340,21 +223,6 @@ class Store {
     return entries.map((e) => e[0]);
   }
 
-  // #region .values()
-  /**
-   * Return an array of the values in the store:
-   *
-   * ```js
-   * const values = await store.values();
-   * // ["value1", { hello: "world" }, ...]
-   *
-   * // To limit it to a given prefix, use `.prefix()`:
-   * const sessions = await store.prefix("session:").values();
-   * ```
-   *
-   * **[→ Full .values() Docs](https://polystore.dev/documentation#values)**
-   * @returns {Promise<Value[]>}
-   */
   async values() {
     await this.promise;
 
@@ -370,21 +238,6 @@ class Store {
     return entries.map((e) => e[1]);
   }
 
-  // #region .all()
-  /**
-   * Return an object with the keys:values in the store:
-   *
-   * ```js
-   * const obj = await store.all();
-   * // { key1: "value1", key2: { hello: "world" }, ... }
-   *
-   * // To limit it to a given prefix, use `.prefix()`:
-   * const sessions = await store.prefix("session:").all();
-   * ```
-   *
-   * **[→ Full .all() Docs](https://polystore.dev/documentation#all)**
-   * @returns {Promise<{ [key:string]: Value }>}
-   */
   async all() {
     await this.promise;
 
@@ -402,19 +255,6 @@ class Store {
     return Object.fromEntries(entries);
   }
 
-  // #region .clear()
-  /**
-   * Delete all of the records of the store:
-   *
-   * ```js
-   * await store.clear();
-   * ```
-   *
-   * It's useful for cache invalidation, clearing the data, and testing.
-   *
-   * **[→ Full .clear() Docs](https://polystore.dev/documentation#clear)**
-   * @returns {Promise<null>}
-   */
   async clear() {
     await this.promise;
 
@@ -427,23 +267,6 @@ class Store {
     await Promise.all(keys.map((key) => this.del(key)));
   }
 
-  // #region .prefix()
-  /**
-   * Create a substore where all the keys are stored with
-   * the given prefix:
-   *
-   * ```js
-   * const session = store.prefix("session:");
-   * await session.set("key1", "value1");
-   * console.log(await session.entries());  // session.
-   * // [["key1", "value1"]]
-   * console.log(await store.entries());  // store.
-   * // [["session:key1", "value1"]]
-   * ```
-   *
-   * **[→ Full .prefix() Docs](https://polystore.dev/documentation#prefix)**
-   * @returns {Store}
-   */
   prefix(prefix = "") {
     const store = new Store(
       Promise.resolve(this.promise).then((client) => client || this.client)
@@ -452,19 +275,6 @@ class Store {
     return store;
   }
 
-  // #region .close()
-  /**
-   * Stop the connection to the store, if any:
-   *
-   * ```js
-   * await session.set("key1", "value1");
-   * await store.close();
-   * await session.set("key2", "value2");  // error
-   * ```
-   *
-   * **[→ Full .close() Docs](https://polystore.dev/documentation#close)**
-   * @returns {Store}
-   */
   async close() {
     await this.promise;