You need to enable JavaScript to run this app. 如何获取可表示任意一组API方法的TypeScript联合类型?
优惠活动
大模型
产品
解决方案
定价
更多

如何获取可表示任意一组API方法的TypeScript联合类型?

可落地的轻量实现

核心问题定位

原写法的卡点主要来自两处:

  • 直接将method指定为keyof fs.promises,会将所有fs.promises的方法(包括完全无路径参数、签名不匹配的方法)纳入可传入范围,无有效类型约束
  • 没有利用泛型保留原方法的完整重载签名,导致封装后丢失原生智能感知能力,同时需要手动维护允许传入的方法列表,维护成本高

实现方案

完全依靠TypeScript原生泛型实现,无额外编译工具、无过度设计,自动适配所有符合签名要求的fs.promises方法,无需手动维护类型列表。

第一步:定义自动筛选的方法类型

通过内置工具类型遍历fs.promises的所有属性,自动挑出符合「第一个参数为路径类型、返回Promise结果」的方法,过滤掉签名不匹配的方法:

import * as fs from 'node:fs/promises';

type PathBasedFsMethod = {
  [K in keyof typeof fs.promises]: 
    typeof fs.promises[K] extends (path: fs.PathLike, ...rest: infer Rest) => infer Ret 
      ? Ret extends Promise<unknown> 
        ? typeof fs.promises[K] 
        : never
      : never
}[keyof typeof fs.promises];

第二步:实现带完整类型保留的工厂函数

通过泛型透传原方法的所有参数、保留全部重载类型,循环逻辑只针对文件不存在(ENOENT)的错误生效,其他错误直接向外抛出:

const fileWaiter = <Method extends PathBasedFsMethod>(method: Method) => {
  return async (...args: Parameters<Method>) => {
    do {
      try {
        return await method(...args);
      } catch (error) {
        if ((error as NodeJS.ErrnoException).code !== 'ENOENT') {
          throw error;
        }
      }
    } while (true)
  }
};

第三步:正常导出封装方法

无需额外类型标注,TypeScript会自动匹配适配:

export const waitFileContents = fileWaiter(fs.promises.readFile);
export const waitFileStat = fileWaiter(fs.promises.stat);

实现效果

  • 类型自动适配:新增fs.promises下符合同样路径签名的方法(如access、readdir、truncate)时,不需要修改现有类型定义即可直接通过fileWaiter封装
  • 智能感知和原生完全一致:比如调用waitFileContents(path, 'utf8')时,类型会正确提示返回string,省略编码参数时返回Buffer,不会因为封装丢失重载类型
  • 逻辑完全符合预期:仅循环等待文件不存在的错误场景,其他文件权限、IO错误会直接向上抛出,不会无限循环等待

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

相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.11.17 05:45:08