VS Code引入cachedClient、cachedDb后intellisense自动补全丢失问题

问题原因 #

VS Code的智能提示依赖JavaScript/TypeScript的类型推断能力，你遇到的问题是未声明类型的缓存变量污染了返回值类型：

• 你声明cachedClient和cachedDb时没有赋值也没有标注类型，编辑器默认将两者推断为any类型
• 函数中存在cachedClient && cachedDb的缓存返回逻辑，编辑器会将整个函数的返回值类型合并为{client: any, db: any}类型
• 类型被标记为any后自然无法关联MongoDB的相关API，智能提示消失
• 注释掉缓存变量后，函数仅返回类型明确的新创建的client、db实例，因此提示恢复

解决方案 #

适用于JavaScript项目 #

无需修改代码逻辑，只需给缓存变量添加JSDoc类型注解即可，编辑器会自动识别类型：

// 旧版本mongodb驱动可额外执行`npm i @types/mongodb -D`安装类型定义包，新版驱动已自带类型
/** @type {import('mongodb').MongoClient | undefined} */
let cachedClient;
/** @type {import('mongodb').Db | undefined} */
let cachedDb;

exports.connectToDatabase = async (dbName) => {
    // 原有逻辑保持不变
    let client = null;

    if (cachedClient && cachedDb) {
         return { client: cachedClient, db: cachedDb };
    }

    try {
        client = await MongoClient.connect(uri, {
            useNewUrlParser: true,
            useUnifiedTopology: true,
        });
    } catch (err) {
        console.log('Error: ', err);
        return;
    }

    const db = client.db(dbName || defaultDbName);
    cachedClient = client;
    cachedDb = db;

    return { client: client, db: db };
};

适用于TypeScript项目 #

直接给缓存变量显式声明类型：

import type { MongoClient, Db } from 'mongodb';

let cachedClient: MongoClient | undefined;
let cachedDb: Db | undefined;

// 原有逻辑保持不变

补充说明 #

你当前代码的catch分支会直接返回undefined，建议补充错误抛出逻辑，避免调用方接收到undefined类型的返回值，进一步保证类型推断的准确性。

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