keyv 5.2.1 → 5.2.3

package/README.md

@@ -144,7 +144,15 @@ await cache.get('foo'); // 'cache'
 
 # Events
 
-Keyv is a custom `EventEmitter` and will emit an `'error'` event if there is an error. In addition it will emit a `clear` and `disconnect` event when the corresponding methods are called.
+Keyv is a custom `EventEmitter` and will emit an `'error'` event if there is an error.
+If there is no listener for the `'error'` event, an uncaught exception will be thrown.
+To disable the `'error'` event, pass `emitErrors: false` in the constructor options.
+
+```js
+const keyv = new Keyv({ emitErrors: false });
+```
+
+In addition it will emit `clear` and `disconnect` events when the corresponding methods are called.
 
 ```js
 const keyv = new Keyv();
@@ -277,41 +285,7 @@ The following are third-party storage adapters compatible with Keyv:
 - [keyv-azuretable](https://github.com/howlowck/keyv-azuretable) - Azure Table Storage/API adapter for Keyv
 - [keyv-arango](https://github.com/TimMikeladze/keyv-arango) - ArangoDB storage adapter for Keyv
 - [keyv-momento](https://github.com/momentohq/node-keyv-adaptor/) - Momento storage adapter for Keyv
-
-# Add Cache Support to your Module
-
-Keyv is designed to be easily embedded into other modules to add cache support. The recommended pattern is to expose a `cache` option in your modules options which is passed through to Keyv. Caching will work in memory by default and users have the option to also install a Keyv storage adapter and pass in a connection string, or any other storage that implements the `Map` API.
-
-You should also set a namespace for your module so you can safely call `.clear()` without clearing unrelated app data.
-
-Inside your module:
-
-```js
-class AwesomeModule {
-	constructor(opts) {
-		this.cache = new Keyv({
-			uri: typeof opts.cache === 'string' && opts.cache,
-			store: typeof opts.cache !== 'string' && opts.cache,
-			namespace: 'awesome-module'
-		});
-	}
-}
-```
-
-Now it can be consumed like this:
-
-```js
-import AwesomeModule from 'awesome-module';
-
-// Caches stuff in memory by default
-const awesomeModule = new AwesomeModule();
-
-// After npm install --save keyv-redis
-const awesomeModule = new AwesomeModule({ cache: 'redis://localhost' });
-
-// Some third-party module that implements the Map API
-const awesomeModule = new AwesomeModule({ cache: some3rdPartyStore });
-```
+- [@resolid/keyv-sqlite](https://github.com/huijiewei/keyv-sqlite) - A new SQLite storage adapter for Keyv
 
 # Compression
 

package/dist/index.cjs

@@ -62,7 +62,7 @@ var EventManager = class {
   off(event, listener) {
     const listeners = this._eventListeners.get(event) ?? [];
     const index = listeners.indexOf(listener);
-    if (index > -1) {
+    if (index !== -1) {
       listeners.splice(index, 1);
     }
     if (listeners.length === 0) {
@@ -231,7 +231,9 @@ var iterableAdapters = [
   "postgres",
   "mysql",
   "mongo",
-  "redis"
+  "redis",
+  "valkey",
+  "etcd"
 ];
 var Keyv = class extends event_manager_default {
   opts;
@@ -291,7 +293,7 @@ var Keyv = class extends event_manager_default {
       if (!this._isValidStorageAdapter(this._store)) {
         throw new Error("Invalid storage adapter");
       }
-      if (typeof this._store.on === "function" && this.opts.emitErrors) {
+      if (typeof this._store.on === "function") {
         this._store.on("error", (error) => this.emit("error", error));
       }
       this._store.namespace = this._namespace;
@@ -325,7 +327,7 @@ var Keyv = class extends event_manager_default {
     if (this._isValidStorageAdapter(store)) {
       this._store = store;
       this.opts.store = store;
-      if (typeof store.on === "function" && this.opts.emitErrors) {
+      if (typeof store.on === "function") {
         store.on("error", (error) => this.emit("error", error));
       }
       if (this._namespace) {
@@ -572,10 +574,19 @@ var Keyv = class extends event_manager_default {
     }
     const formattedValue = { value, expires };
     const serializedValue = await this.serializeData(formattedValue);
-    await store.set(keyPrefixed, serializedValue, ttl);
+    let result = true;
+    try {
+      const value2 = await store.set(keyPrefixed, serializedValue, ttl);
+      if (typeof value2 === "boolean") {
+        result = value2;
+      }
+    } catch (error) {
+      result = false;
+      this.emit("error", error);
+    }
     this.hooks.trigger("postSet" /* POST_SET */, { key: keyPrefixed, value: serializedValue, ttl });
     this.stats.set();
-    return true;
+    return result;
   }
   /**
    * Delete an Entry
@@ -598,7 +609,16 @@ var Keyv = class extends event_manager_default {
     }
     const keyPrefixed = this._getKeyPrefix(key);
     this.hooks.trigger("preDelete" /* PRE_DELETE */, { key: keyPrefixed });
-    const result = await store.delete(keyPrefixed);
+    let result = true;
+    try {
+      const value = await store.delete(keyPrefixed);
+      if (typeof value === "boolean") {
+        result = value;
+      }
+    } catch (error) {
+      result = false;
+      this.emit("error", error);
+    }
     this.hooks.trigger("postDelete" /* POST_DELETE */, { key: keyPrefixed, value: result });
     this.stats.delete();
     return result;
@@ -610,7 +630,11 @@ var Keyv = class extends event_manager_default {
   async clear() {
     this.emit("clear");
     const { store } = this.opts;
-    await store.clear();
+    try {
+      await store.clear();
+    } catch (error) {
+      this.emit("error", error);
+    }
   }
   /**
    * Has a key
@@ -623,7 +647,12 @@ var Keyv = class extends event_manager_default {
     if (store.has !== void 0 && !(store instanceof Map)) {
       return store.has(keyPrefixed);
     }
-    const rawData = await store.get(keyPrefixed);
+    let rawData;
+    try {
+      rawData = await store.get(keyPrefixed);
+    } catch (error) {
+      this.emit("error", error);
+    }
     if (rawData) {
       const data = await this.deserializeData(rawData);
       if (data) {
@@ -646,6 +675,12 @@ var Keyv = class extends event_manager_default {
       return store.disconnect();
     }
   }
+  emit(event, ...arguments_) {
+    if (event === "error" && !this.opts.emitErrors) {
+      return;
+    }
+    super.emit(event, ...arguments_);
+  }
   async serializeData(data) {
     if (!this._serialize) {
       return data;

package/dist/index.d.cts

@@ -260,6 +260,7 @@ declare class Keyv<GenericValue = any> extends EventManager {
      * @returns {Promise<void>}
      */
     disconnect(): Promise<void>;
+    emit(event: string, ...arguments_: any[]): void;
     serializeData<T>(data: DeserializedData<T>): Promise<string | DeserializedData<T>>;
     deserializeData<T>(data: string | DeserializedData<T>): Promise<DeserializedData<T> | undefined>;
 }

package/dist/index.d.ts

@@ -260,6 +260,7 @@ declare class Keyv<GenericValue = any> extends EventManager {
      * @returns {Promise<void>}
      */
     disconnect(): Promise<void>;
+    emit(event: string, ...arguments_: any[]): void;
     serializeData<T>(data: DeserializedData<T>): Promise<string | DeserializedData<T>>;
     deserializeData<T>(data: string | DeserializedData<T>): Promise<DeserializedData<T> | undefined>;
 }

package/dist/index.js

@@ -36,7 +36,7 @@ var EventManager = class {
   off(event, listener) {
     const listeners = this._eventListeners.get(event) ?? [];
     const index = listeners.indexOf(listener);
-    if (index > -1) {
+    if (index !== -1) {
       listeners.splice(index, 1);
     }
     if (listeners.length === 0) {
@@ -205,7 +205,9 @@ var iterableAdapters = [
   "postgres",
   "mysql",
   "mongo",
-  "redis"
+  "redis",
+  "valkey",
+  "etcd"
 ];
 var Keyv = class extends event_manager_default {
   opts;
@@ -265,7 +267,7 @@ var Keyv = class extends event_manager_default {
       if (!this._isValidStorageAdapter(this._store)) {
         throw new Error("Invalid storage adapter");
       }
-      if (typeof this._store.on === "function" && this.opts.emitErrors) {
+      if (typeof this._store.on === "function") {
         this._store.on("error", (error) => this.emit("error", error));
       }
       this._store.namespace = this._namespace;
@@ -299,7 +301,7 @@ var Keyv = class extends event_manager_default {
     if (this._isValidStorageAdapter(store)) {
       this._store = store;
       this.opts.store = store;
-      if (typeof store.on === "function" && this.opts.emitErrors) {
+      if (typeof store.on === "function") {
         store.on("error", (error) => this.emit("error", error));
       }
       if (this._namespace) {
@@ -546,10 +548,19 @@ var Keyv = class extends event_manager_default {
     }
     const formattedValue = { value, expires };
     const serializedValue = await this.serializeData(formattedValue);
-    await store.set(keyPrefixed, serializedValue, ttl);
+    let result = true;
+    try {
+      const value2 = await store.set(keyPrefixed, serializedValue, ttl);
+      if (typeof value2 === "boolean") {
+        result = value2;
+      }
+    } catch (error) {
+      result = false;
+      this.emit("error", error);
+    }
     this.hooks.trigger("postSet" /* POST_SET */, { key: keyPrefixed, value: serializedValue, ttl });
     this.stats.set();
-    return true;
+    return result;
   }
   /**
    * Delete an Entry
@@ -572,7 +583,16 @@ var Keyv = class extends event_manager_default {
     }
     const keyPrefixed = this._getKeyPrefix(key);
     this.hooks.trigger("preDelete" /* PRE_DELETE */, { key: keyPrefixed });
-    const result = await store.delete(keyPrefixed);
+    let result = true;
+    try {
+      const value = await store.delete(keyPrefixed);
+      if (typeof value === "boolean") {
+        result = value;
+      }
+    } catch (error) {
+      result = false;
+      this.emit("error", error);
+    }
     this.hooks.trigger("postDelete" /* POST_DELETE */, { key: keyPrefixed, value: result });
     this.stats.delete();
     return result;
@@ -584,7 +604,11 @@ var Keyv = class extends event_manager_default {
   async clear() {
     this.emit("clear");
     const { store } = this.opts;
-    await store.clear();
+    try {
+      await store.clear();
+    } catch (error) {
+      this.emit("error", error);
+    }
   }
   /**
    * Has a key
@@ -597,7 +621,12 @@ var Keyv = class extends event_manager_default {
     if (store.has !== void 0 && !(store instanceof Map)) {
       return store.has(keyPrefixed);
     }
-    const rawData = await store.get(keyPrefixed);
+    let rawData;
+    try {
+      rawData = await store.get(keyPrefixed);
+    } catch (error) {
+      this.emit("error", error);
+    }
     if (rawData) {
       const data = await this.deserializeData(rawData);
       if (data) {
@@ -620,6 +649,12 @@ var Keyv = class extends event_manager_default {
       return store.disconnect();
     }
   }
+  emit(event, ...arguments_) {
+    if (event === "error" && !this.opts.emitErrors) {
+      return;
+    }
+    super.emit(event, ...arguments_);
+  }
   async serializeData(data) {
     if (!this._serialize) {
       return data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyv",
-  "version": "5.2.1",
+  "version": "5.2.3",
   "description": "Simple key-value storage with support for multiple backends",
   "type": "module",
   "main": "dist/index.cjs",
@@ -69,19 +69,19 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
-    "@keyv/serialize": "*"
+    "@keyv/serialize": "^1.0.2"
   },
   "devDependencies": {
-    "@keyv/compress-brotli": "*",
-    "@keyv/compress-gzip": "*",
-    "@keyv/memcache": "*",
-    "@keyv/mongo": "*",
-    "@keyv/sqlite": "*",
-    "@keyv/test-suite": "*",
     "rimraf": "^6.0.1",
     "timekeeper": "^2.3.1",
     "tsd": "^0.31.2",
-    "xo": "^0.59.3"
+    "xo": "^0.60.0",
+    "@keyv/compress-brotli": "^2.0.2",
+    "@keyv/compress-gzip": "^2.0.2",
+    "@keyv/memcache": "^2.0.1",
+    "@keyv/mongo": "^3.0.1",
+    "@keyv/sqlite": "^4.0.1",
+    "@keyv/test-suite": "^2.0.3"
   },
   "tsd": {
     "directory": "test"