升级Mongoose v5至v6后，如何为MongoDB Change Streams的change事件定义TS类型？

错误原因 #

Mongoose v6对Change Streams的类型系统进行了调整，不再使用v5版本中自定义的ChangeEvent<T>类型，而是直接复用MongoDB Node.js驱动的ChangeStreamDocument系列类型。这导致原有代码中ChangeEvent<ListingDocument>的类型与新的事件参数类型不兼容，触发类型错误。

解决方案 #

1. 导入正确的类型 #

从mongodb包导入对应的Change Stream类型，这些类型涵盖了不同操作类型（更新、插入、删除等）的文档结构：

import { ChangeStreamDocument, ChangeStreamUpdateDocument } from 'mongodb';
import { ListingDocument } from './path-to-your-listing-model'; // 替换为你的ListingDocument实际路径

2. 调整函数参数类型 #

根据业务需求选择合适的类型：

• 仅处理特定操作（如更新）：直接使用对应操作的类型，获得更精确的类型提示：

export default function watchListing() {
  Listing.watch([], { fullDocument: "updateLookup" }).on("change", change => {
    watchUpdatePrices(change);
  });
}

function watchUpdatePrices(change: ChangeStreamUpdateDocument<ListingDocument>) {
  // 可安全访问change.fullDocument，类型为ListingDocument
  // 编写你的业务逻辑
}

• 处理多种操作类型：使用通用的ChangeStreamDocument<ListingDocument>联合类型，配合类型守卫区分不同操作类型：

export default function watchListing() {
  Listing.watch([], { fullDocument: "updateLookup" }).on("change", change => {
    watchUpdatePrices(change);
  });
}

function watchUpdatePrices(change: ChangeStreamDocument<ListingDocument>) {
  switch (change.operationType) {
    case 'update':
      // 此处change自动推断为ChangeStreamUpdateDocument类型
      console.log(change.fullDocument?.price);
      break;
    case 'insert':
      // 处理插入操作逻辑
      break;
    case 'delete':
      // 处理删除操作逻辑
      break;
    default:
      // 处理其他操作类型（如drop、rename等）
      break;
  }
}

3. 确保依赖版本匹配 #

如果遇到类型找不到的问题，确保@types/mongodb版本与Mongoose v6兼容（Mongoose v6通常依赖mongodb驱动4.x版本，对应@types/mongodb4.x版本）。

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