TypeScript - 如何结合使用猫鼬填充来定义模型？

Question

背景

我在我的 Node.JS 应用程序中使用猫鼬和 TypeScript。从数据库中获取数据时，我在很多地方都使用了猫鼬的populate。

我面临的问题是我不知道如何键入我的模型，以便属性可以是 ObjectId 或填充来自另一个集合的数据。

我尝试过的

我尝试在我的模型类型定义中使用联合类型，这似乎是 TypeScript 提供的用于涵盖这些类型的东西：

interface User extends Document {
    _id: Types.ObjectId;
    name: string
}

interface Item extends Document {
    _id: Types.ObjectId;

    // Union typing here
    user: Types.ObjectId | User;
}

我的架构仅将属性定义为带有 ref 的 ObjectId。

const ItemSchema = new Schema({
    user: { type: Schema.Types.ObjectId, ref: "User", index: true }
})

示例：

所以我可能会这样做：

ItemModel.findById(id).populate("user").then((item: Item) => {
    console.log(item.user.name);
})

产生编译错误：

[ts] Property 'name' does not exist on type 'User | ObjectId'.
     Property 'name' does not exist on type 'ObjectId'.

问题

如何在 TypeScript 中拥有可以是两种类型之一的模型属性？

Answer 1

您需要使用类型保护将类型从Types.ObjectId | User 缩小到User...

如果你正在处理一个User 类，你可以使用这个：

if (item.user instanceof User) {
    console.log(item.user.name);
} else {
    // Otherwise, it is a Types.ObjectId
}

如果您的结构与 User 匹配，但不是类的实例（例如，如果 User 是接口），则需要自定义类型保护：

function isUser(obj: User | any) : obj is User {
    return (obj && obj.name && typeof obj.name === 'string');
}

你可以使用的：

if (isUser(item.user)) {
    console.log(item.user.name);
} else {
    // Otherwise, it is a Types.ObjectId
}

如果您不想为此检查结构，可以使用discriminated union。

Answer 2

当用户被填充时，将item.user 转换为User。

ItemModel.findById(id).populate("user").then((item: Item) => {
    console.log((<User>item.user).name);
})

Answer 3

您可以使用 @types/mongoose 库中的 PopulatedDoc 类型。见mongoose.doc。

Answer 4

Mongoose 的 TypeScript 绑定导出一个 PopulatedDoc 类型，可帮助您在 TypeScript 定义中定义填充文档：

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

// `child` is either an ObjectId or a populated document
interface Parent {
  child?: PopulatedDoc<Child & Document>,
  name?: string
}
const ParentModel = model<Parent>('Parent', new Schema({
  child: { type: 'ObjectId', ref: 'Child' },
  name: String
}));

interface Child {
  name?: string;
}
const childSchema: Schema = new Schema({ name: String });
const ChildModel = model<Child>('Child', childSchema);

ParentModel.findOne({}).populate('child').orFail().then((doc: Parent) => {
  // Works
  doc.child.name.trim();
})

下面是 PopulatedDoc 类型的简化实现。它采用 2 个通用参数：填充的文档类型 PopulatedType 和未填充的类型 RawId。 RawId 默认为 ObjectId。

type PopulatedDoc<PopulatedType, RawId = Types.ObjectId> = PopulatedType | RawId;

作为开发人员，您有责任在填充文档和未填充文档之间强制执行强类型化。下面是一个例子。

ParentModel.findOne({}).populate('child').orFail().then((doc: Parent) => {
  // `doc` doesn't have type information that `child` is populated
  useChildDoc(doc.child);
});

// You can use a function signature to make type checking more strict.
function useChildDoc(child: Child): void {
  console.log(child.name.trim());
}

这是从文档中提取的。你可以查看here