无法将猫鼬虚拟与打字稿一起使用

Question

我正在尝试学习如何将虚拟机与猫鼬和打字稿一起使用。

假设我有一个用户界面。

interface User {
    id: mongoose.ObjectId;
    name: string;
    likes: string;
}

然后我为猫鼬创建一个模式。

// create the model
const user: mongoose.SchemaDefinition<User> = {
    name: { type: String },
    likes: { type: String },
};

// enable the use of virtuals
const options: mongoose.SchemaOptions = {
    toJSON: { getters: true, virtuals: true },
    toObject: { virtuals: true },
};

// create the scheme
const schema = new Schema(user, options);

然后我去添加一个虚拟并创建我的模型。

// attach the virtual "bio" to return a string about the user
schema.virtual("bio").get(function (): string {
    return `Hi my name is ${this.name} and i like ${this.likes}`;
});

const model = mongoose.model("User", schema);

但是，像上面那样创建虚拟会在this 上产生此错误。见下图。

所以我想我可以根据this post修改我的虚拟。

schema.virtual("bio").get(function (this: User): string {
    return `Hi my name is ${this.name} and i like ${this.likes}`;
});

const model = mongoose.model("User", schema);

但这对我不起作用，因为我的理论是在我的 tsconfig "noUnusedLocals": true 中设置了以下内容。我不想禁用它，因为它是一个有用的 linting 规则。见下图。

所以我的问题是如何在 typescript 中创建一个不会引发此类错误的 mongoose virtual，是否有一个简单的示例我在谷歌搜索时错过了？

我想一种解决方案是在上面的行中添加// eslint-disable-next-line no-unused-vars 以抑制警告。然而，这并不能解释为什么 this 是“未使用的”。虽然是这样。

我什至尝试通过将this 设置为临时变量（它为用户界面获取 IntelliSense，因此它不像忽略输入）来专门使用 this。

schema.virtual("bio").get(function (this: IUserModel): string {
    const name = this.name;
    const like = this.likes;
    return `Hi my name is ${name} and i like ${like}`;
});

这是我作为一个复制粘贴友好 Blob 的完整示例。

interface User {
    id: mongoose.ObjectId;
    name: string;
    likes: string;
}

const user: mongoose.SchemaDefinition<User> = {
    name: { type: String },
    likes: { type: String },
};

const options: mongoose.SchemaOptions = {
    toJSON: { getters: true, virtuals: true },
    toObject: { virtuals: true },
};

const schema = new Schema(user, options);

// this is defined but never used :(
schema.virtual("bio").get(function (this: User): string {
    return `Hi my name is ${this.name} and i like ${this.likes}`;
});

const model = mongoose.model("User", schema);

export default model;

Answer 1

如果您正在使用 typescript，则需要设置这些属性

user.set("toObject", { virtuals: true });
user.set("toJSON", { virtuals: true });