keyv 5.5.1 → 5.5.3

package/README.md

@@ -44,6 +44,7 @@ There are a few existing modules similar to Keyv, however Keyv is different beca
   - [.deserialize](#deserialize)
   - [.compression](#compression)
   - [.useKeyPrefix](#usekeyprefix)
+  - [.stats](#stats)
   - [Keyv Instance](#keyv-instance)
 	- [.set(key, value, [ttl])](#setkey-value-ttl)
 	- [.setMany(entries)](#setmanyentries)
@@ -672,6 +673,55 @@ const keyv = new Keyv({ store: keyvRedis, throwOnErrors: true });
 
 What this does is it only throw on connection errors with the Redis client.
 
+## .stats
+Type: `StatsManager`<br />
+Default: `StatsManager` instance with `enabled: false`
+
+The stats property provides access to statistics tracking for cache operations. When enabled via the `stats` option during initialization, it tracks hits, misses, sets, deletes, and errors.
+
+### Enabling Stats:
+```js
+const keyv = new Keyv({ stats: true });
+console.log(keyv.stats.enabled); // true
+```
+
+### Available Statistics:
+- `hits`: Number of successful cache retrievals
+- `misses`: Number of failed cache retrievals
+- `sets`: Number of set operations
+- `deletes`: Number of delete operations
+- `errors`: Number of errors encountered
+
+### Accessing Stats:
+```js
+const keyv = new Keyv({ stats: true });
+
+await keyv.set('foo', 'bar');
+await keyv.get('foo'); // cache hit
+await keyv.get('nonexistent'); // cache miss
+await keyv.delete('foo');
+
+console.log(keyv.stats.hits);    // 1
+console.log(keyv.stats.misses);  // 1
+console.log(keyv.stats.sets);    // 1
+console.log(keyv.stats.deletes); // 1
+```
+
+### Resetting Stats:
+```js
+keyv.stats.reset();
+console.log(keyv.stats.hits); // 0
+```
+
+### Manual Control:
+You can also manually enable/disable stats tracking at runtime:
+```js
+const keyv = new Keyv({ stats: false });
+keyv.stats.enabled = true; // Enable stats tracking
+// ... perform operations ...
+keyv.stats.enabled = false; // Disable stats tracking
+```
+
 # How to Contribute
 
 We welcome contributions to Keyv! 🎉 Here are some guides to get you started with contributing:

package/dist/index.cjs

@@ -776,7 +776,8 @@ var Keyv = class extends event_manager_default {
             }
             const formattedValue = { value, expires };
             const serializedValue = await this.serializeData(formattedValue);
-            return { key, value: serializedValue, ttl };
+            const keyPrefixed = this._getKeyPrefix(key);
+            return { key: keyPrefixed, value: serializedValue, ttl };
           })
         );
         results = await this._store.setMany(serializedEntries);
@@ -909,7 +910,7 @@ var Keyv = class extends event_manager_default {
       return store.hasMany(keyPrefixed);
     }
     const results = [];
-    for (const key of keyPrefixed) {
+    for (const key of keys) {
       results.push(await this.has(key));
     }
     return results;

package/dist/index.js

@@ -750,7 +750,8 @@ var Keyv = class extends event_manager_default {
             }
             const formattedValue = { value, expires };
             const serializedValue = await this.serializeData(formattedValue);
-            return { key, value: serializedValue, ttl };
+            const keyPrefixed = this._getKeyPrefix(key);
+            return { key: keyPrefixed, value: serializedValue, ttl };
           })
         );
         results = await this._store.setMany(serializedEntries);
@@ -883,7 +884,7 @@ var Keyv = class extends event_manager_default {
       return store.hasMany(keyPrefixed);
     }
     const results = [];
-    for (const key of keyPrefixed) {
+    for (const key of keys) {
       results.push(await this.has(key));
     }
     return results;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyv",
-  "version": "5.5.1",
+  "version": "5.5.3",
   "description": "Simple key-value storage with support for multiple backends",
   "type": "module",
   "main": "dist/index.cjs",
@@ -55,12 +55,12 @@
     "tsd": "^0.33.0",
     "vitest": "^3.2.4",
     "@keyv/mongo": "^3.0.3",
+    "@keyv/compress-gzip": "^2.0.3",
     "@keyv/compress-lz4": "^1.0.1",
     "@keyv/memcache": "^2.0.2",
     "@keyv/sqlite": "^4.0.5",
-    "@keyv/test-suite": "^2.1.1",
     "@keyv/compress-brotli": "^2.0.5",
-    "@keyv/compress-gzip": "^2.0.3"
+    "@keyv/test-suite": "^2.1.1"
   },
   "tsd": {
     "directory": "test"
@@ -71,8 +71,10 @@
   ],
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
-    "test": "biome check --write && vitest run --coverage",
-    "test:ci": "biome check && vitest --run --sequence.setupFiles=list --coverage",
+    "lint": "biome check --write --error-on-warnings",
+    "lint:ci": "biome check --error-on-warnings",
+    "test": "pnpm lint && vitest run --coverage",
+    "test:ci": "pnpm lint:ci && vitest --run --sequence.setupFiles=list --coverage",
     "clean": "rimraf ./node_modules ./coverage ./test/testdb.sqlite ./dist"
   }
 }