keyv 5.3.2 → 5.3.4

package/README.md

@@ -24,6 +24,46 @@ There are a few existing modules similar to Keyv, however Keyv is different beca
 - Connection errors are passed through (db failures won't kill your app)
 - Supports the current active LTS version of Node.js or higher
 
+# Table of Contents
+- [Usage](#usage)
+- [Type-safe Usage](#type-safe-usage)
+- [Using Storage Adapters](#using-storage-adapters)
+- [Namespaces](#namespaces)
+- [Events](#events)
+- [Hooks](#hooks)
+- [Custom Serializers](#custom-serializers)
+- [Official Storage Adapters](#official-storage-adapters)
+- [Third-party Storage Adapters](#third-party-storage-adapters)
+- [Compression](#compression)
+- [API](#api)
+  - [new Keyv([storage-adapter], [options]) or new Keyv([options])](#new-keyvstorage-adapter-options-or-new-keyvoptions)
+  - [.namespace](#namespace)
+  - [.ttl](#ttl)
+  - [.store](#store)
+  - [.serialize](#serialize)
+  - [.deserialize](#deserialize)
+  - [.compression](#compression)
+  - [.useKeyPrefix](#usekeyprefix)
+  - [Keyv Instance](#keyv-instance)
+	- [.set(key, value, [ttl])](#setkey-value-ttl)
+	- [.setMany(entries)](#setmanyentries)
+	- [.get(key, [options])](#getkey-options)
+	- [.getMany(keys, [options])](#getmanykeys-options)
+	- [.delete(key)](#deletekey)
+	- [.deleteMany(keys)](#deletemanykeys)
+	- [.clear()](#clear)
+	- [.iterator()](#iterator)
+- [API - Properties](#api---properties)
+  - [.namespace](#namespace-1)
+  - [.ttl](#ttl-1)
+  - [.store](#store-1)
+  - [.serialize](#serialize-1)
+  - [.deserialize](#deserialize-1)
+  - [.compression](#compression-1)
+  - [.useKeyPrefix](#usekeyprefix-1)
+- [How to Contribute](#how-to-contribute)
+- [License](#license)
+
 # Usage
 
 Install Keyv.
@@ -189,7 +229,7 @@ import Keyv, { KeyvHooks } from 'keyv';
 ```js
 //PRE_SET hook
 const keyv = new Keyv();
-keyv.hooks.addHandler(KeyvHooks.PRE_SET, (key, value) => console.log(`Setting key ${key} to ${value}`));
+keyv.hooks.addHandler(KeyvHooks.PRE_SET, (data) => console.log(`Setting key ${data.key} to ${data.value}`));
 
 //POST_SET hook
 const keyv = new Keyv();
@@ -200,9 +240,10 @@ In these examples you can also manipulate the value before it is set. For exampl
 
 ```js
 const keyv = new Keyv();
-keyv.hooks.addHandler(KeyvHooks.PRE_SET, (key, value) => {
-  console.log(`Setting key ${key} to ${value}`);
-  key = `prefix-${key}`;
+keyv.hooks.addHandler(KeyvHooks.PRE_SET, (data) => {
+  console.log(`Manipulating key ${data.key} and ${data.value}`);
+  data.key = `prefix-${data.key}`;
+  data.value = `prefix-${data.value}`;
 });
 ```
 

package/dist/index.cjs

@@ -83,14 +83,6 @@ var EventManager = class {
       for (const listener of listeners) {
         listener(...arguments_);
       }
-    } else if (event === "error") {
-      if (arguments_[0] instanceof Error) {
-        throw arguments_[0];
-      } else {
-        const error = new CustomError(arguments_[0]);
-        error.context = arguments_[0];
-        throw error;
-      }
     }
   }
   // Get all listeners for a specific event
@@ -110,17 +102,6 @@ var EventManager = class {
     this._maxListeners = n;
   }
 };
-var CustomError = class _CustomError extends Error {
-  context;
-  constructor(message, context) {
-    super(message);
-    this.context = context;
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, _CustomError);
-    }
-    this.name = this.constructor.name;
-  }
-};
 var event_manager_default = EventManager;
 
 // src/hooks-manager.ts
@@ -482,6 +463,7 @@ var Keyv = class extends event_manager_default {
   _isValidStorageAdapter(store) {
     return store instanceof Map || typeof store.get === "function" && typeof store.set === "function" && typeof store.delete === "function" && typeof store.clear === "function";
   }
+  // eslint-disable-next-line @stylistic/max-len
   async get(key, options) {
     const { store } = this.opts;
     const isArray = Array.isArray(key);
@@ -568,24 +550,24 @@ var Keyv = class extends event_manager_default {
    * @returns {boolean} if it sets then it will return a true. On failure will return false.
    */
   async set(key, value, ttl) {
-    this.hooks.trigger("preSet" /* PRE_SET */, { key, value, ttl });
-    const keyPrefixed = this._getKeyPrefix(key);
-    if (ttl === void 0) {
-      ttl = this._ttl;
-    }
-    if (ttl === 0) {
-      ttl = void 0;
+    const data = { key, value, ttl };
+    this.hooks.trigger("preSet" /* PRE_SET */, data);
+    const keyPrefixed = this._getKeyPrefix(data.key);
+    data.ttl ??= this._ttl;
+    if (data.ttl === 0) {
+      data.ttl = void 0;
     }
     const { store } = this.opts;
-    const expires = typeof ttl === "number" ? Date.now() + ttl : null;
-    if (typeof value === "symbol") {
+    const expires = typeof data.ttl === "number" ? Date.now() + data.ttl : void 0;
+    if (typeof data.value === "symbol") {
       this.emit("error", "symbol cannot be serialized");
+      throw new Error("symbol cannot be serialized");
     }
-    const formattedValue = { value, expires };
+    const formattedValue = { value: data.value, expires };
     const serializedValue = await this.serializeData(formattedValue);
     let result = true;
     try {
-      const value2 = await store.set(keyPrefixed, serializedValue, ttl);
+      const value2 = await store.set(keyPrefixed, serializedValue, data.ttl);
       if (typeof value2 === "boolean") {
         result = value2;
       }
@@ -606,8 +588,21 @@ var Keyv = class extends event_manager_default {
     let results = [];
     try {
       if (this._store.setMany !== void 0) {
-        results = await this._store.setMany(entries);
-        return results;
+        const serializedEntries = await Promise.all(entries.map(async ({ key, value, ttl }) => {
+          ttl ??= this._ttl;
+          if (ttl === 0) {
+            ttl = void 0;
+          }
+          const expires = typeof ttl === "number" ? Date.now() + ttl : void 0;
+          if (typeof value === "symbol") {
+            this.emit("error", "symbol cannot be serialized");
+            throw new Error("symbol cannot be serialized");
+          }
+          const formattedValue = { value, expires };
+          const serializedValue = await this.serializeData(formattedValue);
+          return { key, value: serializedValue, ttl };
+        }));
+        results = await this._store.setMany(serializedEntries);
       }
       const promises = [];
       for (const entry of entries) {

package/dist/index.d.cts

@@ -42,7 +42,7 @@ declare class StatsManager extends EventManager {
 
 type DeserializedData<Value> = {
     value?: Value;
-    expires?: number | null;
+    expires?: number | undefined;
 };
 type CompressionAdapter = {
     compress(value: any, options?: any): Promise<any>;

package/dist/index.d.ts

@@ -42,7 +42,7 @@ declare class StatsManager extends EventManager {
 
 type DeserializedData<Value> = {
     value?: Value;
-    expires?: number | null;
+    expires?: number | undefined;
 };
 type CompressionAdapter = {
     compress(value: any, options?: any): Promise<any>;

package/dist/index.js

@@ -57,14 +57,6 @@ var EventManager = class {
       for (const listener of listeners) {
         listener(...arguments_);
       }
-    } else if (event === "error") {
-      if (arguments_[0] instanceof Error) {
-        throw arguments_[0];
-      } else {
-        const error = new CustomError(arguments_[0]);
-        error.context = arguments_[0];
-        throw error;
-      }
     }
   }
   // Get all listeners for a specific event
@@ -84,17 +76,6 @@ var EventManager = class {
     this._maxListeners = n;
   }
 };
-var CustomError = class _CustomError extends Error {
-  context;
-  constructor(message, context) {
-    super(message);
-    this.context = context;
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, _CustomError);
-    }
-    this.name = this.constructor.name;
-  }
-};
 var event_manager_default = EventManager;
 
 // src/hooks-manager.ts
@@ -456,6 +437,7 @@ var Keyv = class extends event_manager_default {
   _isValidStorageAdapter(store) {
     return store instanceof Map || typeof store.get === "function" && typeof store.set === "function" && typeof store.delete === "function" && typeof store.clear === "function";
   }
+  // eslint-disable-next-line @stylistic/max-len
   async get(key, options) {
     const { store } = this.opts;
     const isArray = Array.isArray(key);
@@ -542,24 +524,24 @@ var Keyv = class extends event_manager_default {
    * @returns {boolean} if it sets then it will return a true. On failure will return false.
    */
   async set(key, value, ttl) {
-    this.hooks.trigger("preSet" /* PRE_SET */, { key, value, ttl });
-    const keyPrefixed = this._getKeyPrefix(key);
-    if (ttl === void 0) {
-      ttl = this._ttl;
-    }
-    if (ttl === 0) {
-      ttl = void 0;
+    const data = { key, value, ttl };
+    this.hooks.trigger("preSet" /* PRE_SET */, data);
+    const keyPrefixed = this._getKeyPrefix(data.key);
+    data.ttl ??= this._ttl;
+    if (data.ttl === 0) {
+      data.ttl = void 0;
     }
     const { store } = this.opts;
-    const expires = typeof ttl === "number" ? Date.now() + ttl : null;
-    if (typeof value === "symbol") {
+    const expires = typeof data.ttl === "number" ? Date.now() + data.ttl : void 0;
+    if (typeof data.value === "symbol") {
       this.emit("error", "symbol cannot be serialized");
+      throw new Error("symbol cannot be serialized");
     }
-    const formattedValue = { value, expires };
+    const formattedValue = { value: data.value, expires };
     const serializedValue = await this.serializeData(formattedValue);
     let result = true;
     try {
-      const value2 = await store.set(keyPrefixed, serializedValue, ttl);
+      const value2 = await store.set(keyPrefixed, serializedValue, data.ttl);
       if (typeof value2 === "boolean") {
         result = value2;
       }
@@ -580,8 +562,21 @@ var Keyv = class extends event_manager_default {
     let results = [];
     try {
       if (this._store.setMany !== void 0) {
-        results = await this._store.setMany(entries);
-        return results;
+        const serializedEntries = await Promise.all(entries.map(async ({ key, value, ttl }) => {
+          ttl ??= this._ttl;
+          if (ttl === 0) {
+            ttl = void 0;
+          }
+          const expires = typeof ttl === "number" ? Date.now() + ttl : void 0;
+          if (typeof value === "symbol") {
+            this.emit("error", "symbol cannot be serialized");
+            throw new Error("symbol cannot be serialized");
+          }
+          const formattedValue = { value, expires };
+          const serializedValue = await this.serializeData(formattedValue);
+          return { key, value: serializedValue, ttl };
+        }));
+        results = await this._store.setMany(serializedEntries);
       }
       const promises = [];
       for (const entry of entries) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyv",
-  "version": "5.3.2",
+  "version": "5.3.4",
   "description": "Simple key-value storage with support for multiple backends",
   "type": "module",
   "main": "dist/index.cjs",
@@ -57,20 +57,20 @@
     "@keyv/serialize": "^1.0.3"
   },
   "devDependencies": {
-    "@faker-js/faker": "^9.5.1",
-    "@vitest/coverage-v8": "^3.0.7",
+    "@faker-js/faker": "^9.8.0",
+    "@vitest/coverage-v8": "^3.2.3",
     "rimraf": "^6.0.1",
     "timekeeper": "^2.3.1",
-    "tsd": "^0.31.2",
-    "vitest": "^3.0.7",
-    "xo": "^0.60.0",
-    "@keyv/compress-brotli": "^2.0.3",
-    "@keyv/compress-gzip": "^2.0.2",
-    "@keyv/test-suite": "^2.0.5",
+    "tsd": "^0.32.0",
+    "vitest": "^3.2.3",
+    "xo": "^1.1.0",
+    "@keyv/compress-brotli": "^2.0.4",
+    "@keyv/compress-gzip": "^2.0.3",
+    "@keyv/sqlite": "^4.0.4",
     "@keyv/memcache": "^2.0.1",
-    "@keyv/sqlite": "^4.0.1",
-    "@keyv/compress-lz4": "^1.0.0",
-    "@keyv/mongo": "^3.0.1"
+    "@keyv/test-suite": "^2.0.7",
+    "@keyv/mongo": "^3.0.2",
+    "@keyv/compress-lz4": "^1.0.0"
   },
   "tsd": {
     "directory": "test"