如何在Next.js中用TypeScript操作MongoDB？遇类型错误求助

问题描述 #

在Next.js中按照非TypeScript的教程集成MongoDB时，遇到以下类型错误：

Property 'mongoClient' does not exist on type '{ mongoClient: any; } | undefined'.

错误原因 #

1. connectToDatabase函数未明确返回类型，且catch块无返回值，TypeScript推断其返回类型为Promise<{ mongoClient: TypedEventEmitter<MongoClientEvents> } | undefined>，解构时无法确定是否存在mongoClient属性。
2. mongoClient的类型定义错误，new MongoClient().connect()返回的是MongoClient实例，而非TypedEventEmitter<MongoClientEvents>。

解决方案 #

1. 修正connectToDatabase.ts的类型与错误处理 #

修改数据库连接文件，明确类型定义并确保函数始终返回有效结果：

// connectToDatabase.ts
import { MongoClient } from 'mongodb'

const uri = process.env.MONGODB_URI as string
const options = {}
let mongoClient: MongoClient | undefined

if (!process.env.MONGODB_URI) {
    throw new Error('请配置MONGODB_URI环境变量')
}

export async function connectToDatabase(): Promise<{ mongoClient: MongoClient }> {
    try {
        if (mongoClient) {
            return { mongoClient }
        }
        mongoClient = await new MongoClient(uri, options).connect()
        return { mongoClient }
    } catch (e) {
        console.error('数据库连接失败:', e)
        throw e // 重新抛出错误，避免函数返回undefined
    }
}

2. 优化API路由的错误处理（可选） #

调整list.ts的错误处理逻辑，确保异常时返回合理的HTTP状态码：

// /pages/api/list.ts
import { connectToDatabase } from '../../lib/connectToDatabase'
import type { NextApiRequest, NextApiResponse } from 'next'

export default async function handler(
    req: NextApiRequest,
    res: NextApiResponse
) {
    try {
        const { mongoClient } = await connectToDatabase()
        const db = mongoClient.db('sample_restaurants')
        const collection = db.collection('restaurants')
        // 补充project参数，避免运行时错误
        const results = await collection.find({}).project({}).toArray()
        res.status(200).json({ results })
    } catch (e) {
        res.status(500).json({ error: '获取数据失败' })
        console.error(e)
    }
}

关键说明 #

• 明确函数返回类型后，TypeScript可以确定connectToDatabase始终返回包含mongoClient的对象，消除解构时的类型错误。
• 修正mongoClient的类型为MongoClient | undefined，匹配实际的实例类型，避免后续调用db()等方法时出现额外类型错误。
• 原代码中project()方法缺少参数会导致运行时错误，建议补充空对象或按需指定投影字段。

内容的提问来源于stack exchange，提问作者János