如何在TypeScript中正确表示Mongoose模型及MongooseMap类型

要正确表示Mongoose模型中的Map字段，你需要使用Mongoose提供的**MongooseMap类型**——它是原生Map的扩展，包含toJSON()、toObject()等Mongoose专属方法，同时能提供完整的类型检查能力。

具体修改步骤： #

1. 直接使用MongooseMap类型：从mongoose模块中引用该类型，替换你之前的泛型对象定义。
2. 兼容创建文档的输入类型：因为创建文档时可以传入普通对象或原生Map，所以在属性接口中用联合类型兼容两种输入。
3. 保留类型安全：避免使用any，根据实际场景指定Map值的类型（比如unknown或具体类型）。

修改后的完整代码： #

import { NotificationType } from "@/types/notification";
import mongoose from "mongoose";

interface NotificationAttrs {
    receivers: mongoose.Types.ObjectId[];
    sender: mongoose.Types.ObjectId;
    type: NotificationType;
    data: Record<string, unknown> | Map<string, unknown>; // 兼容普通对象或原生Map输入
    sentAt: Date;
}

interface NotificationModel extends mongoose.Model<NotificationDoc> {
    build(attrs: NotificationAttrs): NotificationDoc;
}

interface NotificationDoc extends mongoose.Document {
    receivers: mongoose.Types.ObjectId[];
    sender: mongoose.Types.ObjectId;
    type: NotificationType;
    data: mongoose.MongooseMap<unknown>; // 使用MongooseMap定义类型
    sentAt: Date;
}

const notificationSchema = new mongoose.Schema({
    receivers: [{ type: mongoose.Types.ObjectId, ref: 'User' }],
    sender: { type: mongoose.Types.ObjectId, required: true },
    type: { type: String, required: true, enum: Object.values(NotificationType) },
    data: { type: Map, of: mongoose.Schema.Types.Mixed, required: true },
    sentAt: { type: Date, required: true },
});

notificationSchema.statics.build = (attrs: NotificationAttrs) => {
    return new Notification(attrs);
};

const Notification = mongoose.model<NotificationDoc, NotificationModel>('Notification', notificationSchema);

export { Notification };

方案优势： #

• TypeScript能正确识别toJSON()等MongooseMap专属方法，消除类型报错。
• 相比{ [key: string]: any }，MongooseMap<unknown>能提供类型安全约束：仅允许调用Map和MongooseMap的合法方法，禁止访问不存在的属性。
• 若data字段的值有固定类型（比如全是字符串或数字），可以将unknown替换为具体类型（如mongoose.MongooseMap<string>），进一步增强类型检查。

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