TypeScript下Mongoose userSchema.methods中使用this访问属性报错问题
报错核心原因
- Mongoose 定义 Schema 实例方法时,默认会把方法内部的
this推导为通用的原生Document类型,这个类型仅包含文档通用基础方法,不包含你自定义的tokens、name等业务字段。 - 你虽然定义了继承
Document的IUser业务接口,但没有把这个接口类型和实例方法的this做绑定,TS识别不到自定义属性,就会触发TS2339报错。
具体修正方案
- 在
IUser接口中补充所有自定义实例方法的类型声明,补全类型链路 - 给实例方法显式标注
this的类型为IUser,覆盖Mongoose默认推导的通用Document类型 - 创建Mongoose模型时通过泛型参数传入
IUser,对齐模型的类型定义 - 注意:定义Mongoose实例方法不能使用箭头函数,箭头函数会按词法作用域劫持
this指向,完全丢失Mongoose绑定的文档上下文,哪怕类型标注正确,运行时也会抛出属性不存在的错误
import { Schema, Model, Document, model } from 'mongoose'; import jwt from 'jsonwebtoken'; // 补全业务接口的类型定义 export interface IUser extends Document { name: string; email: string; password: string; tokens: { token: string }[]; encryptPassword(password: string): Promise<string>; validatePassword(password: string): Promise<boolean>; // 补充遗漏的实例方法类型声明 generateAuthToken(): Promise<string>; } const userSchema = new Schema({ name: { type: String, required: true, trim: true }, email: { type: String, unique: true, required: true }, password: { type: String, required: true, minlength: 5, trim: true }, tokens: [{ token: { type: String, required: true } }] }) // 显式标注this类型,TS即可正确识别所有自定义属性 userSchema.methods.generateAuthToken = async function (this: IUser) { const token = jwt.sign({ _id: this._id.toString() }, "thisismysecretkey") this.tokens = this.tokens.concat({ token }) // 补充原代码缺失的持久化、返回逻辑 await this.save() return token } // 创建模型时传入IUser泛型,打通全链路类型检查 const UserModel: Model<IUser> = model<IUser>('User', userSchema)
额外提示:如果后续需要给Schema添加静态方法,同样需要在对应的静态方法定义上显式标注
this的类型为绑定了IUser的Model类型,避免出现同类的类型推导问题。
内容的提问来源于stack exchange,提问作者rakesht
相关产品推荐
相关产品推荐

