TypeScript报错：findOne获取的User实例无comparePassword属性

问题根源 #

TypeScript默认无法识别Mongoose Schema上自定义的实例方法，因为User.findOne()返回的类型是Mongoose内置的Document类型，未包含你自定义的comparePassword方法。而新建User实例时能正常调用，是因为实例直接关联了包含方法定义的类型。

解决方案步骤 #

1. 完善用户接口定义 #

确保你的IUser接口继承Mongoose的Document，并显式声明comparePassword方法：

import { Document, ObjectId } from 'mongoose';

interface IUser extends Document {
  _id: ObjectId;
  username: string;
  password: string;
  // 声明自定义实例方法
  comparePassword(candidatePassword: string): Promise<boolean>;
}

2. 正确挂载实例方法到Schema #

定义Schema时，把comparePassword挂载到schema.methods上，同时指定Schema的类型为IUser：

import mongoose, { Schema } from 'mongoose';
import bcrypt from 'bcrypt';

const userSchema = new Schema<IUser>({
  username: { type: String, required: true, unique: true },
  password: { type: String, required: true }
});

// 挂载自定义实例方法（必须用普通函数，不能用箭头函数，否则会丢失this指向）
userSchema.methods.comparePassword = async function (candidatePassword: string): Promise<boolean> {
  return await bcrypt.compare(candidatePassword, this.password);
};

3. 创建模型时指定正确的类型 #

创建User模型时，确保返回的模型类型关联IUser：

const User = mongoose.model<IUser>('User', userSchema);

4. 登录路由中的类型处理 #

此时User.findOne()返回的是Promise<IUser | null>，直接调用方法即可，可配合类型守卫避免空值报错：

app.post('/login', async (req, res) => {
  const { username, password } = req.body;
  const foundUser = await User.findOne({ username });

  if (!foundUser) {
    return res.status(401).json({ message: '用户不存在' });
  }

  // TypeScript已能识别comparePassword方法
  const isMatch = await foundUser.comparePassword(password);
  isMatch 
    ? res.status(200).json({ message: '登录成功' })
    : res.status(401).json({ message: '密码错误' });
});

额外排查点 #

• 若之前接口未继承Document，TypeScript无法关联Mongoose文档与自定义方法，这是最常见的错误原因。
• 必须用普通函数定义实例方法，箭头函数会丢失this指向，同时TypeScript无法推断this的类型为IUser。

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