兼容TypeScript的Mongoose Schema方法扩展方案

TypeScript报错的核心原因是：默认生成的Model实例类型为通用Document，编译器无法识别你通过Schema.methods添加的自定义方法。要解决这个问题，需通过显式定义类型接口让TypeScript知晓这些方法的存在，具体实现步骤如下：

1. 定义包含自定义方法的文档接口 #

创建继承自mongoose.Document的接口，同时声明Schema字段和自定义方法：

import mongoose, { Document, Schema } from 'mongoose';

// 定义文档结构，包含字段和自定义实例方法
interface MyDocument extends Document {
  deletedAt?: Date;
  myDelete(): void;
  myUndelete(): void;
}

2. 创建Schema时绑定接口类型 #

实例化Schema时通过泛型指定刚才定义的MyDocument接口，让Schema与类型关联：

const MySchema = new Schema<MyDocument>({
  deletedAt: Date
});

3. 添加自定义方法并指定this类型 #

添加方法时显式指定this的类型为MyDocument（避免TypeScript将this推断为any），确保方法内的字段访问有类型校验：

// 通过methods对象添加方法
MySchema.methods.myDelete = function(this: MyDocument) {
  this.deletedAt = new Date();
};

// 通过method()方法添加
MySchema.method('myUndelete', function(this: MyDocument) {
  this.deletedAt = null;
});

4. 创建Model时指定泛型 #

创建Model时通过泛型指定MyDocument，这样实例化后的对象会自动包含自定义方法：

const MyModel = mongoose.model<MyDocument>('MyCollection', MySchema);

// 实例化后可正常调用方法，无TypeScript报错
const myInstance = new MyModel();
myInstance.myDelete();
myInstance.myUndelete();

扩展：添加静态方法（Model层面） #

如果需要给Model添加静态方法，同样可以通过接口声明实现类型支持：

// 扩展Model的静态方法接口
interface MyModel extends mongoose.Model<MyDocument> {
  findDeleted(): Promise<MyDocument[]>;
}

// 添加静态方法
MySchema.statics.findDeleted = function(this: MyModel) {
  return this.find({ deletedAt: { $ne: null } });
};

// 创建Model时指定第二个泛型为MyModel
const MyModel = mongoose.model<MyDocument, MyModel>('MyCollection', MySchema);

// 调用静态方法
MyModel.findDeleted();

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