如何使用TypeScript扩展Mongoose Query？适配缓存代码遇问题

我来帮你搞定这个TypeScript适配Mongoose扩展的问题～你说的用声明合并扩展Query对象没生效，大概率是因为Mongoose的类型系统已经从全局命名空间切换到ES模块了，原来的写法不对。

为什么你的写法没生效？ #

旧版Mongoose的类型用的是全局Mongoose命名空间，但现在v5+之后，官方类型定义全部改用ES模块导出，所以你用declare namespace Mongoose去扩展，TS根本找不到对应的接口，自然不会生效。

正确的解决方案 #

1. 创建类型声明文件（.d.ts）

在你的项目里新建一个类型声明文件，比如src/types/mongoose.d.ts，内容如下：

// 先导入Mongoose的Query类型，确保TS能找到基类
import { Query } from 'mongoose';

// 扩展'mongoose'模块下的Query接口
declare module 'mongoose' {
  // 要和原Query接口的泛型参数保持一致，避免类型冲突
  interface Query<ResultType, DocType, THelpers = {}, RawDocType = DocType> {
    // 这里可以给cache定义更具体的类型，比如支持传入配置参数
    cache(options?: { key?: string }): this;
  }
}

2. 配置tsconfig.json确保声明文件被识别

打开你的tsconfig.json，确保include数组包含了这个声明文件的路径，比如：

{
  "compilerOptions": {
    // 其他配置...
    "strict": true // 建议开启严格模式，类型检查更准确
  },
  "include": [
    "src/**/*",
    "src/types/**/*.d.ts" // 包含你的类型声明文件
  ]
}

3. 实现Query.prototype.cache方法

在你的缓存服务代码里，给Mongoose的Query原型添加cache方法，比如：

import mongoose from 'mongoose';

// 给Query原型扩展cache方法
mongoose.Query.prototype.cache = function(options = {}) {
  // 这里可以根据你的缓存逻辑添加属性，比如标记是否启用缓存、缓存key等
  this.useCache = true;
  this.cacheKey = options.key || JSON.stringify(this.getQuery());
  
  return this; // 返回this支持链式调用，和Mongoose的API风格一致
};

验证是否生效 #

现在你就可以在代码里链式调用cache()方法了，TS也会正确识别这个方法：

// 示例：查询时使用缓存
const users = await User.find({ status: 'active' }).cache({ key: 'active-users' });

这样应该就能解决你扩展Query对象无效的问题啦～

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