node-redis中createClient()类型及TS传参类型错误咨询

在TypeScript开发场景中，将await createClient()创建的node-redis客户端实例传入自定义Cron类时，遭遇类型不兼容错误。相关代码及错误信息如下：

客户端创建代码 #

import { createClient } from "redis";
const redisClient = await createClient({ url: "redis://default:1234@redis:6379" })
  .on("error", (err) => console.log("Redis Client Error", err))
  .connect();

const cron = new Cron(redisClient);

Cron类定义 #

class Cron {
  private redisClient: RedisClientType<Record<string, never>, Record<string, never>>

  constructor(redisClient: RedisClientType<Record<string, never>, Record<string, never>>) {
    this.redisClient = redisClient;
  }
}

错误信息 #

Argument of type 'RedisClientType<{ graph: { CONFIG_GET: typeof import(".../node_modules/@redis/graph/dist/commands/CONFIG_GET"); configGet: typeof import(".../node_modules/@redis/graph/dist/commands/CONFIG_GET"); ... 15 more ...; slowLog: typeof import("/Users/tung/...' is not assignable to parameter of type 'RedisClientType<Record<string, never>, Record<string, never>>'.
  Type 'RedisClientType<{ graph: { CONFIG_GET: typeof import(".../node_modules/@redis/graph/dist/commands/CONFIG_GET"); configGet: typeof import(".../node_modules/@redis/graph/dist/commands/CONFIG_GET"); ... 15 more ...; slowLog: typeof import("/Users/tung/...' is not assignable to type 'RedisClient<Record<string, never>, Record<string, never>, Record<string, never>>'.
    Types of property 'options' are incompatible.
      Type 'RedisClientOptions<{ graph: { CONFIG_GET: typeof import(".../node_modules/@redis/graph/dist/commands/CONFIG_GET"); configGet: typeof import(".../node_modules/@redis/graph/dist/commands/CONFIG_GET"); ... 15 more ...; slowLog: typeof import("/Users/tu...' is not assignable to type 'RedisClientOptions<Record<string, never>, Record<string, never>, Record<string, never>>'.
        Type '{ graph: { CONFIG_GET: typeof import(".../node_modules/@redis/graph/dist/commands/CONFIG_GET"); configGet: typeof import(".../node_modules/@redis/graph/dist/commands/CONFIG_GET"); ... 15 more ...; slowLog: typeof import("...' is not assignable to type 'Record<string, never>'.
          'string' index signatures are incompatible.
            Type 'RedisModule' is not assignable to type 'never'.

此前参考相关方案使用RedisClientType<Record<string, never>, Record<string, never>>作为类型，但未解决问题。现咨询：

1. node-redis中createClient()的类型是什么？
2. 如何解决该类型不兼容问题？

1. createClient()的返回类型 #

createClient()的返回类型为**RedisClientType<RedisModules, RedisFunctions, RedisScripts>**，其中：

• RedisModules：客户端加载的Redis内置/自定义模块类型（如Graph、Search等），默认包含node-redis内置的模块类型
• RedisFunctions：自定义Redis函数的类型，默认值为空对象
• RedisScripts：自定义Lua脚本的类型，默认值为空对象

调用connect()后返回的是同一个RedisClientType实例（已处于连接状态）。

2. 类型不兼容问题的解决方案 #

错误核心原因是：自定义Cron类强制指定了RedisClientType<Record<string, never>, Record<string, never>>（表示客户端无任何模块属性），但实际createClient()返回的客户端包含内置Redis模块类型（如graph、slowLog），两者类型约束冲突。以下是三种可行解决方式：

方案一：用泛型自动推导类型 #

让Cron类接受泛型参数，适配任意合法的Redis客户端类型：

import { RedisClientType } from "redis";

class Cron<M extends Record<string, any> = Record<string, any>, F = Record<string, never>, S = Record<string, never>> {
  private redisClient: RedisClientType<M, F, S>;

  constructor(redisClient: RedisClientType<M, F, S>) {
    this.redisClient = redisClient;
  }
}

创建Cron实例时，TypeScript会自动推导传入客户端的真实类型，避免冲突。

方案二：使用基础RedisClient类型 #

如果不需要在Cron类中调用Redis模块的特定方法，可直接使用RedisClient基类（从redis导入），它兼容所有createClient()创建的实例：

import { RedisClient } from "redis";

class Cron {
  private redisClient: RedisClient;

  constructor(redisClient: RedisClient) {
    this.redisClient = redisClient;
  }
}

方案三：显式指定匹配的模块类型 #

若确认不需要使用任何Redis模块，可在创建客户端时显式指定泛型参数，让返回类型与Cron类定义匹配：

import { createClient, RedisClientType } from "redis";

// 显式指定模块类型为无属性的Record
const redisClient = await createClient<Record<string, never>>({ url: "redis://default:1234@redis:6379" })
  .on("error", (err) => console.log("Redis Client Error", err))
  .connect();

class Cron {
  private redisClient: RedisClientType<Record<string, never>, Record<string, never>>;

  constructor(redisClient: RedisClientType<Record<string, never>, Record<string, never>>) {
    this.redisClient = redisClient;
  }
}

const cron = new Cron(redisClient); // 类型匹配，无错误

此方式会丢失模块相关的类型提示，仅适合完全不需要Redis模块的场景。

内容的提问来源于stack exchange，提问作者forbidden