打字稿中的猫鼬查询助手：查询类型上不存在属性

Question

基于mongoose的documentation，我尝试创建一个可链接的byYear查询助手方法如下：

import * as mongoose from 'mongoose'
import { IMovie } from '../interfaces/movies'

export interface MovieDocument extends IMovie, mongoose.Document {}

const schema = new mongoose.Schema({
    id: {
        type: String,
        required: [true, 'Missing ID'],
        index: { unique: true },
    },
    title: { type: String, required: [true, 'Missing title'] },
    year: Number,
    director: String,
    actor: [String],
})

schema.query.byYear = function (year) {
    return this.find({ year: year })
}

export const Movie = mongoose.model<MovieDocument>(
    'Movies',
    schema,
    'Movies'
)

其中IMovie 是一个简单的interface，具有与schema 相同的字段。

然后我尝试使用我的查询助手：

Movie.find().byYear(year).then(movies => {
    console.log('found these movies:', movies)
}).catch(err => {
    console.log('error:' + err)
})

但我得到Property 'byYear' does not exist on type 'Query<MovieDocument[], MovieDocument, {}>' 的Movie.find().byYear() 部分。尽管如此，代码似乎可以工作，但似乎由于输入不足，VS Code 没有意识到Movie.find() 返回的Query 实际上确实 有一个byYear 方法。我该如何正确地做到这一点？

---

2021-05-02 更新：我应该更多地强调我提供的代码工作很漂亮。我的问题和问题的问题更适合如何在 TypeScript 中正确“输入”它，或者仅仅是为什么会发生错误。

Answer 1

你应该这样做

Movie.find().byYear(year).exec((err, movies) => {
  if (err) {
        console.log('error:' + err)
  } else {
        console.log('found these movies:', movies)
  }
})

基本上你应该使用.exec 和不 .then 方法。
你可以在这里找到更多参考https://mongoosejs.com/docs/guide.html#query-helpers

Answer 2

你需要像下面这样导出它

  export interface MovieDocument extends IMovie, mongoose.Document {
    }
    
    const schema = new mongoose.Schema({
        id: {
            type: String,
            required: [true, 'Missing ID'],
            index: { unique: true },
        },
        title: { type: String, required: [true, 'Missing title'] },
        year: Number,
        director: String,
        actor: [String],
    })
    
    schema.query.byYear = function(year){
        return this.find({ year: year });
    }
    
    const Movie = mongoose.model<MovieDocument>(
        'Movies',
        schema
    );

module.exports = Movie; // this file will i have saved it as movie.ts extension

并且像这样在助手中访问 确保在导入时使用 require，我已经测试过它并且它工作正常

const Movie = require('./models/movie'); 

Movie.find().byYear(2020).then((movies: any) => {
    console.log('found these movies:', movies)
}).catch((err: any) => {
    console.log('error:' + err)
})