如何在TypeScript中正确为MongoDB的find方法添加类型定义

你的问题核心在于集合与文档类型的对应关系不明确，以及使用联合类型导致TypeScript无法精准推断属性。下面是具体的修正方案和解释：

关键问题分析 #

1. 你当前查询的是reits集合，但给find指定了ReitsType | ActionsType联合类型——一个集合通常只存储单一类型的文档，这种联合类型会让TypeScript只能识别两个类型的公共属性，丢失自动补全能力。
2. sortKey使用了联合类型的键，但实际排序的是reits集合的字段，类型范围过大导致类型检查失效。

修正后的代码 #

import { ReitsType } from '@/app/api/types/reits';
import { NextRequest, NextResponse } from 'next/server';
import { db } from '../mongo';

export async function GET(req: NextRequest) {
    console.log(req);
    // 明确sortKey是ReitsType的键，而非联合类型
    const sortKey: keyof ReitsType = 'averageDy5YearsRanking';
    try {
        // 为collection指定泛型，明确该集合的文档类型是ReitsType
        const collection = db.collection<ReitsType>('reits');
        // collection已指定类型，find无需重复传泛型，自动继承ReitsType
        const documents = await collection
            .find({
                averageDy5YearsRanking: { $gte: 5 }
            })
            .sort({ [sortKey]: 1 })
            .toArray();
        return NextResponse.json(documents);
    } catch (error) {
        console.error('Error while fetching data:', error);
        return NextResponse.error();
    }
}

核心修改说明 #

• 为集合指定泛型：通过db.collection<ReitsType>('reits')明确reits集合的文档类型，后续所有操作（find、sort、update等）都会自动使用该类型，无需重复声明。
• 缩小sortKey的类型范围：将sortKey限定为keyof ReitsType，确保只能使用ReitsType中存在的字段，TypeScript会提供精准的属性补全，同时避免传入不存在的字段导致错误。
• 移除find的冗余泛型：集合已指定类型后，find()会自动推断返回的文档类型，无需额外传入find<ReitsType>。

如需处理多类型集合的场景 #

如果你的业务确实需要在同一个逻辑中处理不同类型的集合（比如动态切换reits和actions集合），可以通过类型守卫来区分类型：

import { ReitsType } from '@/app/api/types/reits';
import { NextRequest, NextResponse } from 'next/server';
import { db } from '../mongo';
import { ActionsType } from '../types/actions';

// 类型守卫：判断文档是否为ReitsType
function isReitsType(doc: ReitsType | ActionsType): doc is ReitsType {
    return 'averageDy5YearsRanking' in doc;
}

export async function GET(req: NextRequest) {
    console.log(req);
    // 根据业务逻辑动态选择集合和类型
    const useReitsCollection = true;
    let documents: (ReitsType | ActionsType)[];

    try {
        if (useReitsCollection) {
            const collection = db.collection<ReitsType>('reits');
            documents = await collection.find({ averageDy5YearsRanking: { $gte: 5 } }).sort({ averageDy5YearsRanking: 1 }).toArray();
        } else {
            const collection = db.collection<ActionsType>('actions');
            documents = await collection.find({ /* ActionsType的查询条件 */ }).toArray();
        }

        // 使用类型守卫处理不同类型的文档
        documents.forEach(doc => {
            if (isReitsType(doc)) {
                // 这里TypeScript会识别doc为ReitsType，提供对应属性补全
                console.log(doc.averageDy5YearsRanking);
            } else {
                // 这里doc为ActionsType
                console.log(doc.someActionsField);
            }
        });

        return NextResponse.json(documents);
    } catch (error) {
        console.error('Error while fetching data:', error);
        return NextResponse.error();
    }
}

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