Nest.js中Mongoose静态方法findByAge无法被IDE识别的问题

问题原因 #

你定义了CatModel类型扩展Mongoose的Model并包含静态方法，但Service中注入的模型未关联该自定义类型，导致IDE无法识别findByAge静态方法。

修复步骤 #

1. 修正静态方法类型与实现 #

在cat.schema.ts中，调整静态方法的类型定义（匹配Mongoose异步查询的返回值），并修改实现方式避免覆盖默认静态方法：

// 修正静态方法类型
interface CatStatics {
    findByAge: (age: number) => Promise<Cat[]>;
}

// 单独挂载静态方法，而非直接赋值对象
CatSchema.statics.findByAge = async function(age: number): Promise<Cat[]> {
    return this.find({ age }).exec();
};

2. 模块注册时关联自定义模型类型 #

在cat.module.ts中注册模型时，明确指定类型为CatModel：

import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import { Cat, CatSchema, CatModel } from './cat.schema';
import { CatService } from './cat.service';

@Module({
  imports: [
    MongooseModule.forFeature([
      { name: Cat.name, schema: CatSchema }
    ])
  ],
  providers: [CatService]
})
export class CatModule {}

3. Service中注入指定类型的模型 #

在cat.service.ts中，注入模型时直接指定CatModel类型：

import { Injectable } from '@nestjs/common';
import { InjectModel } from '@nestjs/mongoose';
import { Cat, CatModel } from './cat.schema';

@Injectable()
export class CatService {
  constructor(
    @InjectModel(Cat.name) private readonly catModel: CatModel
  ) {}

  async getCatsByAge() {
    // IDE现在会正确识别findByAge方法
    const data = await this.catModel.findByAge(12);
    return data;
  }

  async getCatsByName() {
    const cat = new this.catModel();
    const result = await cat.findByName("abc");
    return result;
  }
}

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