如何使用打字稿在猫鼬模型中定义自定义查询助手？

Question

我想使用 query helper api 定义自定义查询助手。 这里是例子：

// models/article.ts

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

interface IArticle extends Document {
   name: string;
}

interface IArticleModel extends Model<IArticle> {
   someStaticMethod(): Promise<any>;
}

const ArticleSchema = new Schema( { name: String } )

ArticleSchema.query.byName = function(name) {
    return this.find({ name })
}

export default model<IArticle, IArticleModel>('Article', ArticleSchema);



// routes/article.ts
import ArticleModel from '../models/article.ts'

router.get('/articles, (req, res) => {
    ArticleModel.find().byName('example')
})

当我使用默认值链接时，Typescript 抱怨 byName 方法。
我可以将它放在IArticleModel 接口中，但在这种情况下，我只能从模型中调用它。
我应该把这个方法的定义放在哪里才能以可链接的方式使用它？

Answer 1

我起草了支持查询助手的a new version of @types/mongoose。有关安装修改后的 @types 软件包的方法，请参阅 this answer。使用我的版本，您应该可以在models/article.ts 中编写以下内容：

import { Document, Schema, Model, model, DocumentQuery } from 'mongoose';

interface IArticle extends Document {
   name: string;
}

interface IArticleModel extends Model<IArticle, typeof articleQueryHelpers> {
   someStaticMethod(): Promise<any>;
}

const ArticleSchema = new Schema( { name: String } )

let articleQueryHelpers = {
    byName(this: DocumentQuery<any, IArticle>, name: string) {
        return this.find({ name });
    }
};
ArticleSchema.query = articleQueryHelpers;

export default model<IArticle, IArticleModel>('Article', ArticleSchema);

然后routes/article.ts 将起作用。如果这对你有用，那么我将在DefiniteTyped 上向原始包提交一个拉取请求。