TypeScript与Mongoose报错：Document类型无transform等属性

嘿，我之前也碰到过一模一样的问题！本质原因是TypeScript默认的Document和Model类型不知道我们给Mongoose文档、模型添加的自定义方法，所以才会抛出类型错误。直接用any虽然能临时绕过实例方法的报错，但解决不了静态方法的问题，而且也不是优雅的类型安全方案。下面是完整的正确解法：

第一步：定义自定义类型接口 #

我们需要扩展Mongoose的Document和Model类型，把自己的方法声明进去，让TypeScript能识别它们：

import mongoose, { Schema, Document, Model } from "mongoose";

// 1. 定义用户文档的字段和实例方法
interface IUser extends Document {
  email: string;
  name?: string;
  role: string;
  createdAt: Date;
  // 声明实例方法transform的类型
  transform(): Record<string, string | Date>;
}

// 2. 定义模型的静态方法接口
interface IUserModel extends Model<IUser> {
  // 这里可以根据你的roles实际类型更精确定义，比如枚举或string[]
  roles: string[];
  checkDuplicateEmailError(err: unknown): Error | unknown;
}

第二步：创建Schema并实现方法 #

创建Schema时指定泛型为IUser，实现方法时还能获得正确的类型提示：

const userSchema: Schema<IUser> = new Schema(
  {
    email: {
      type: String,
      required: true,
      unique: true,
      lowercase: true,
    },
    name: {
      type: String,
      maxlength: 50,
    },
    role: {
      type: String,
      required: true,
    },
    createdAt: {
      type: Date,
      default: Date.now,
    }
    // 补充你省略的其他字段
  }
);

// 实现实例方法transform
userSchema.methods.transform = function(this: IUser) {
  const transformed: Record<string, string | Date> = {};
  const fields = ["id", "name", "email", "createdAt", "role"];
  fields.forEach((field) => {
    transformed[field] = this[field];
  });
  return transformed;
};

// 实现静态方法
const roles = ["user", "admin"]; // 替换成你的实际roles值
userSchema.statics = {
  roles,
  checkDuplicateEmailError(err: unknown) {
    if (err instanceof Error && (err as any).code === 11000) {
      return new Error("Email already taken");
    }
    return err;
  },
};

第三步：导出带类型的模型 #

导出模型时指定泛型为IUser和IUserModel，这样TypeScript就能识别我们的自定义静态方法了：

export default mongoose.model<IUser, IUserModel>("User", userSchema);

第四步：控制器里正常使用 #

现在回到你的控制器代码，savedUser.transform()和User.checkDuplicateEmailError(error)都不会再报类型错误了——TypeScript已经完全知道这些方法的存在啦！

为什么之前用any只能解决一半问题？因为mongoose.model<any>(...)只是把文档实例的类型设为any，绕过了实例方法的检查，但模型本身还是默认的Model<Document>类型，所以静态方法依然找不到。而通过自定义接口扩展类型，才是从根源上解决问题的类型安全方案。

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