TypeScript对接Mongoose时Document缺少IAccount的_type、pai属性报错如何解决

你遇到的两个TS报错本质都是Mongoose类型系统和你自定义的IAccount接口没有正确绑定，再加上save方法传参格式错误导致的：

• 第一类返回值报错：你未给Mongoose Model指定关联IAccount的泛型，创建的newAccount实例是通用Document<any, any, any>类型，TS无法识别该实例上存在IAccount定义的_type、pai等自定义属性，因此触发类型校验失败。
• 第二类save方法报错：有两个诱因，一是通用Document类型的save方法重载匹配逻辑和绑定自定义类型的Model不同，二是你直接将ClientSession作为参数传入save，不符合Mongoose的API要求——save方法第一个参数是SaveOptions类型对象，session需要作为该对象的字段传入，而非直接传session实例。

步骤1：定义绑定IAccount的Mongoose专属类型 #

首先基于你已有的IAccount接口，扩展出Mongoose Document和Model的专属类型，替换原来的无类型定义：

import { Document, Model, Types, ClientSession } from 'mongoose';

// 保留原有IAccount定义，注意将_id类型调整为Mongoose的ObjectId
interface IAccount {
  _id: Types.ObjectId;
  _type: "Account";
  pai: string;
  disabledOn?: Date;
  tags?: ITag[];
  schemaVersion?: number;
  createdOn?: Date;
  updatedOn?: Date;
}

// 扩展出Document类型，同时继承Document和IAccount的属性方法
interface IAccountDocument extends IAccount, Document {}
// 定义Account对应的Model类型
type IAccountModel = Model<IAccountDocument>;

步骤2：修正Schema字段定义和Schema实例创建 #

替换原来的Record<keyof IAccount, any>写法，使用Mongoose提供的SchemaDefinition类型做字段校验，同时创建Schema时传入泛型绑定类型：

import { Schema, SchemaDefinition } from 'mongoose';

const AccountSchemaFields: SchemaDefinition<IAccount> = {
  _id: Types.ObjectId,
  _type: { type: String, default: "Account", enum: ["Account"] },
  pai: { type: String, required: true },
  disabledOn: { type: Date, required: false },
  tags: { type: [TagSchema], required: false },
  schemaVersion: { type: Number, default: 1 },
  createdOn: Date,
  updatedOn: Date,
};

// 创建Schema时传入Document和Model的泛型，完成类型绑定
export const AccountSchema = new Schema<IAccountDocument, IAccountModel>(
  AccountSchemaFields,
  // 如果需要自动生成createdOn、updatedOn字段可以加timestamps配置，不需要可删除
  { timestamps: { createdAt: 'createdOn', updatedAt: 'updatedOn' } }
);

步骤3：修正createAccount方法的两处错误 #

一是确认你注入的Model类型为IAccountModel，二是修正save方法的传参格式，同时可以删除冗余的嵌套class写法：

async createAccount(
    dbSession: ClientSession,
    pai: string
  ): Promise<IAccount> {
    // 直接传构造参数即可，无需额外定义实现IAccount的class
    const newAccount = new this.Model({
      _id: new Types.ObjectId(),
      pai
    });
    // save方法传入符合SaveOptions格式的参数，session作为对象字段传入
    await newAccount.save({ session: dbSession });
    // 如果需要返回纯JS对象而非Mongoose Document实例，调用toObject转换
    return newAccount.toObject() as IAccount;
    // 若允许返回Document实例，直接return newAccount即可，IAccountDocument已继承IAccount
  }

你之前用到的any类型虽然不是直接诱因，但确实会屏蔽很多类型校验问题，替换为SchemaDefinition<IAccount>后，Schema字段定义错误会被TS提前捕获，避免运行时问题。

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