You need to enable JavaScript to run this app. TypeScript使用interface时方法返回值在编辑器悬浮提示不显示详情问题
优惠活动
大模型
产品
解决方案
定价
更多

TypeScript使用interface时方法返回值在编辑器悬浮提示不显示详情问题

问题原因

  • Firestore 的 doc.data() 方法默认返回通用的 DocumentData 类型,你直接将该返回值赋值给标注了 DonationInterface[] 类型的变量,属于强制类型覆盖,TypeScript 会跳过对该赋值逻辑的结构校验,编辑器也不会主动展开被强转的接口内部字段。而你手动重建返回对象时,相当于显式完成了每个字段的类型匹配校验,TS 确认返回值完全符合接口定义,因此可以正常展示字段详情。
  • JSDoc 中的 @returns 标注和实际方法返回的 Promise 类型不匹配,会干扰编辑器的提示解析逻辑。

修复方案

  1. 修正 JSDoc 返回值标注,和实际方法签名保持对齐
  2. 给 QuerySnapshot 显式指定泛型约束,在取文档数据时就明确返回值类型,避免后期强制类型覆盖
  3. 若修改后提示仍未生效,可重启编辑器的 TS 语言服务(VSCode 按下 Ctrl+Shift+P 选择「TypeScript: 重新启动 TS 服务器」即可)

修复后完整代码

import firebase from "../firebase/init";
import { DonationInterface } from "../interfaces/donation";

export class Donations {
  donationsRef: firebase.firestore.CollectionReference;

  // 初始化集合引用
  constructor(_business_id: string) {
    this.donationsRef = firebase
      .firestore()
      .collection(`business/${_business_id}/list`);
  }
  /**
   * 获取当前所有捐赠记录列表
   *
   * @returns {Promise<DonationInterface[]>} 已初始化商家的全部捐赠记录数组
   * @example
   *     const donations = await new Donations('你的商家ID').list(); // => [item, item, item]
   */
  async list(): Promise<DonationInterface[]> {
    // 给查询快照指定泛型,明确内部文档对应DonationInterface类型
    const snap = await this.donationsRef.get() as firebase.firestore.QuerySnapshot<DonationInterface>;

    const docDataArray = snap.docs.map(doc => {
      // 带泛型的doc.data()会自动返回DonationInterface类型,无需额外标注
      return doc.data();
    });

    return docDataArray;
  }
}

内容的提问来源于stack exchange,提问作者Max

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.09 12:24:02