Mongoose中Document类型无remove方法的TS2339错误求助

问题原因 #

Mongoose 6及以上版本已废弃文档实例的remove()方法，官方推荐使用deleteOne()/deleteMany()或模型层面的删除方法，同时TypeScript的类型定义也移除了remove()的声明，因此编译时触发TS2339错误。

解决方案 #

有两种可行的修改方式，推荐第一种（更高效，减少一次数据库查询）：

方案1：使用模型的findByIdAndDelete方法直接删除

修改控制器中的deleteNote函数，无需先查询文档再删除，直接通过模型方法完成操作：

import NoteModel from "../models/note";
import { RequestHandler } from 'express';
import createHttpErrors from "http-errors";
import mongoose from "mongoose";

export const deleteNote: RequestHandler = async (req, res, next) => {
    const noteId = req.params.noteId;

    try {
        if (!mongoose.isValidObjectId(noteId)) {
            throw createHttpErrors(400, "invalid Note ID")
        }

        // 直接通过模型方法查找并删除
        const deletedNote = await NoteModel.findByIdAndDelete(noteId).exec();

        if (!deletedNote) {
            throw createHttpErrors(404, "Note not found")
        }

        res.sendStatus(204)
    } catch (error) {
        next(error)
    }
}

方案2：改用实例的deleteOne()方法替换remove()

如果需要保留先查询文档的逻辑，将await note.remove();替换为await note.deleteOne();即可：

// ... 其他代码不变
await note.deleteOne();
// ... 其他代码不变

说明 #

两种方案都能解决类型错误，方案1减少了一次数据库查询操作，性能更优；方案2适合需要先对文档做额外处理再删除的场景。模型和路由代码无需修改。

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