Typescript/Mongoose 错误：findUser 在模型类型上不存在答案

【问题标题】：Typescript/Mongoose Error: findUser does not exist on type ModelTypescript/Mongoose 错误：findUser 在模型类型上不存在
【发布时间】：2021-06-22 20:48:28
【问题描述】：

我有以下代码。我想使用 MongoDB、mongoose、使用 typescript 来实现身份验证。我遇到了打字稿问题。我尝试为 findUser 声明类型（可能不正确）但没有解决。有什么建议吗？

model.ts

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

export interface IUser extends Document {
  username: string;
  password: string;
}

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

// tslint:disable-next-line: only-arrow-functions
userSchema.statics.findUser = async function (username, password) {
  const user = await User.findOne({ username });
  if (!user) {
    return;
  }

  const isMatch = await bcrypt.compare(password, user.password);
  if (!isMatch) {
    return;
  }
  return user;
};

userSchema.pre<IUser>('save', async function (next) {
  const user = this;
  if (user.isModified('password')) {
    user.password = await bcrypt.hash(user.password, 8);
  }
  next();
});

const User = mongoose.model<IUser & Document>('User', userSchema);
export default User;

auth.ts（路由）错误：“模型”类型上不存在属性“findUser”。ts(2339)

import express from 'express';
import User from '../models/user-model';
const router = express.Router();

declare module 'express-session' {
  // tslint:disable-next-line: interface-name
  export interface SessionData {
    user: { [key: string]: any };
  }
}

router.post('/signin', async (req, res) => {
  const { email, password } = req.body;
  const user = await User.findUser(email, password);
  if (user) {
    req.session.user = user._id;
    res.json({
      message: 'You are successfully login',
      auth: true,
    });
  } else {
    res.json({
      message: 'Unable to login',
      auth: false,
    });
  }
});



export = router;

【问题讨论】：

标签： mongodb typescript express mongoose express-session

【解决方案1】：

您可以在描述模型本身的mongoose.model() 方法上设置second generic。

这里我们包含Model<IUser> 的所有属性并添加您的自定义函数。

type UserModel = Model<IUser> & {
    findUser: (username: string, password: string) => Promise<IUser | undefined>;
}

IUser 确定此模型中文档的类型，而UserModel 确定模型的类型。

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

现在方法的类型是已知的。 user 这里获取类型IUser | undefined;

const user = await User.findUser('joe', 'abcd');

Typescript Playground Link

【讨论】：