如何为带联合类型的TypeScript接口编写MongoDB Mongoose Schema

解决方案 #

你可以通过以下两种方式实现和TypeScript联合类型匹配的mongoose字段定义：

1. 推荐方案：明确指定允许的类型数组

直接将type字段设置为包含Boolean、Number、String的数组，完全匹配你boolean | number | string的类型约束：

const schema = new Schema<IDataItem>({
  id: { type: String, required: true },
  value: { type: [Boolean, Number, String], required: true },
  temp: { type: Boolean, required: true },
});

该方案的优势：

• mongoose会自动校验存入的value是否属于三个允许的类型之一，不符合会直接抛出校验错误，和TS接口的约束完全对齐
• 字段变更可以被mongoose自动检测，不需要手动标记修改

2. 兼容扩展方案：使用Mixed混合类型

如果后续value可能扩展其他类型，可以用mongoose自带的混合类型：

const schema = new Schema<IDataItem>({
  id: { type: String, required: true },
  value: { type: Schema.Types.Mixed, required: true },
  temp: { type: Boolean, required: true },
});

注意事项：

• 该方案允许任意类型的值存入value字段，约束性弱，无法匹配你当前的联合类型校验需求
• 修改value字段的值后，需要手动调用document.markModified('value')，再执行保存操作才能生效，否则mongoose无法检测到该字段的变更

额外注意事项 #

• 你原代码中Schema的泛型参数写的是IData，需要和你定义的接口名IDataItem保持一致，避免TypeScript类型校验报错

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