@keyv/redis 4.1.0 → 4.2.0

package/README.md

@@ -26,6 +26,7 @@ Redis storage adapter for [Keyv](https://github.com/jaredwray/keyv).
 # Table of Contents
 * [Usage](#usage)
 * [Namespaces](#namespaces)
+* [Typescript](#typescript)
 * [Performance Considerations](#performance-considerations)
 * [High Memory Usage on Redis Server](#high-memory-usage-on-redis-server)
 * [Using Cacheable with Redis](#using-cacheable-with-redis)
@@ -110,6 +111,34 @@ keyv.namespace = 'my-namespace';
 
 NOTE: If you plan to do many clears or deletes, it is recommended to read the [Performance Considerations](#performance-considerations) section.
 
+## Typescript
+
+When initializing `KeyvRedis`, you can specify the type of the values you are storing and you can also specify types when calling methods:
+
+```typescript
+import Keyv from 'keyv';
+import KeyvRedis, { createClient } from '@keyv/redis';
+
+
+interface User {
+  id: number
+  name: string
+}
+
+const redis = createClient('redis://user:pass@localhost:6379');
+
+const keyvRedis = new KeyvRedis<User>(redis);
+const keyv = new Keyv({ store: keyvRedis });
+
+await keyv.set("user:1", { id: 1, name: "Alice" })
+const user = await keyv.get("user:1")
+console.log(user.name) // 'Alice'
+
+// specify types when calling methods
+const user = await keyv.get<User>("user:1")
+console.log(user.name) // 'Alice'
+```
+
 # Performance Considerations
 
 With namespaces being prefix based it is critical to understand some of the performance considerations we have made:

package/dist/index.d.cts

@@ -53,7 +53,7 @@ type KeyvRedisEntry<T> = {
     ttl?: number;
 };
 type RedisClientConnectionType = RedisClientType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts>;
-declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
+declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
     private _client;
     private _namespace;
     private _keyPrefixSeparator;
@@ -162,13 +162,13 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
      * @param {string} key - the key to get
      * @returns {Promise<string | undefined>} - the value or undefined if the key does not exist
      */
-    get<T>(key: string): Promise<T | undefined>;
+    get<U = T>(key: string): Promise<U | undefined>;
     /**
      * Get many values from the store. If a key does not exist, it will return undefined.
      * @param {Array<string>} keys - the keys to get
      * @returns {Promise<Array<string | undefined>>} - array of values or undefined if the key does not exist
      */
-    getMany<T>(keys: string[]): Promise<Array<T | undefined>>;
+    getMany<U = T>(keys: string[]): Promise<Array<U | undefined>>;
     /**
      * Delete a key from the store.
      * @param {string} key - the key to delete
@@ -216,7 +216,7 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
      * @param {string} [namespace] - the namespace to iterate over
      * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
      */
-    iterator<Value>(namespace?: string): AsyncGenerator<[string, Value | undefined], void, unknown>;
+    iterator<U = T>(namespace?: string): AsyncGenerator<[string, U | undefined], void, unknown>;
     /**
      * Clear all keys in the store.
      * IMPORTANT: this can cause performance issues if there are a large number of keys in the store and worse with clusters. Use with caution as not recommended for production.

package/dist/index.d.ts

@@ -53,7 +53,7 @@ type KeyvRedisEntry<T> = {
     ttl?: number;
 };
 type RedisClientConnectionType = RedisClientType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts>;
-declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
+declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
     private _client;
     private _namespace;
     private _keyPrefixSeparator;
@@ -162,13 +162,13 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
      * @param {string} key - the key to get
      * @returns {Promise<string | undefined>} - the value or undefined if the key does not exist
      */
-    get<T>(key: string): Promise<T | undefined>;
+    get<U = T>(key: string): Promise<U | undefined>;
     /**
      * Get many values from the store. If a key does not exist, it will return undefined.
      * @param {Array<string>} keys - the keys to get
      * @returns {Promise<Array<string | undefined>>} - array of values or undefined if the key does not exist
      */
-    getMany<T>(keys: string[]): Promise<Array<T | undefined>>;
+    getMany<U = T>(keys: string[]): Promise<Array<U | undefined>>;
     /**
      * Delete a key from the store.
      * @param {string} key - the key to delete
@@ -216,7 +216,7 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
      * @param {string} [namespace] - the namespace to iterate over
      * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
      */
-    iterator<Value>(namespace?: string): AsyncGenerator<[string, Value | undefined], void, unknown>;
+    iterator<U = T>(namespace?: string): AsyncGenerator<[string, U | undefined], void, unknown>;
     /**
      * Clear all keys in the store.
      * IMPORTANT: this can cause performance issues if there are a large number of keys in the store and worse with clusters. Use with caution as not recommended for production.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/redis",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Redis storage adapter for Keyv",
   "type": "module",
   "main": "dist/index.cjs",
@@ -36,7 +36,7 @@
   "dependencies": {
     "cluster-key-slot": "^1.1.2",
     "redis": "^4.7.0",
-    "keyv": "^5.2.1"
+    "keyv": "^5.2.2"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^2.1.8",
@@ -59,8 +59,8 @@
   ],
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
-    "test": "xo --fix && vitest run --coverage",
-    "test:ci": "xo && vitest --run --sequence.setupFiles=list",
+    "test": "xo --fix && vitest run --coverage --typecheck",
+    "test:ci": "xo && vitest --run --sequence.setupFiles=list --typecheck",
     "clean": "rimraf ./node_modules ./coverage ./dist"
   }
 }