迁移Umzug至v3遇TypeScript错误：'umzug.on'未被识别

原因分析 #

1. 类型推断模糊：你的connectUmzug函数未指定明确的返回类型，TypeScript无法准确推断返回的Umzug实例类型，导致继承自Emittery的on方法未被正确识别。
2. 依赖版本冲突：项目中可能存在多个版本的Emittery（Umzug v3依赖Emittery实现事件系统），版本不一致会导致类型定义不兼容，进而无法识别on方法。
3. TypeScript版本限制：较低版本的TypeScript对泛型类继承的类型解析存在缺陷，无法正确识别父类Emittery的方法。

解决方案 #

1. 明确指定函数返回类型 #

给connectUmzug添加明确的返回类型，帮助TypeScript正确推断实例类型：

import Umzug from 'umzug';

// 根据你的实际上下文类型替换Record<string, any>
export async function connectUmzug(dbConfig): Promise<Umzug<Record<string, any>>> {
  return new Umzug({...});
}

2. 检查并统一Emittery版本 #

执行以下命令查看项目中Emittery的版本情况：

npm ls emittery

若存在多个版本冲突，执行npm dedupe自动合并依赖版本，或在package.json中手动指定统一的Emittery版本。

3. 升级TypeScript版本 #

将TypeScript升级到4.5及以上版本，提升对泛型继承的类型解析能力：

npm install typescript@latest --save-dev

4. 手动补充类型声明（可选） #

如果上述方法无效，可手动导入Emittery类型并合并到返回类型中：

import Umzug from 'umzug';
import type { Emittery } from 'emittery';

export async function connectUmzug(dbConfig): Promise<Umzug<Record<string, any>> & Emittery> {
  return new Umzug({...});
}

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