Node.js中util.promisify处理stream.pipeline引发参数警告的解决与疑问

最优解决方案：使用官方原生Promise版pipeline #

从Node.js 15.0.0开始，stream模块提供了专门的Promise版本API，直接从stream/promises导入即可，完全不需要手动用util.promisify包装，类型定义也完美匹配：

import { pipeline } from "stream/promises";
import fs from "fs";

await pipeline(
  file.stream,
  fs.createWriteStream(`${__dirname}${uploaderConfig.savePath}${fileName}`)
);

这样写不仅没有类型警告，代码也更简洁，是官方推荐的写法。

兼容旧Node.js版本的解决方案 #

如果你还在使用Node.js 14及以下版本，必须用util.promisify的话，可以手动指定asyncPipeline的类型来修正IDEA的错误提示：

import { pipeline } from "stream";
import { promisify } from "util";
import type { Stream } from "stream";

// 手动定义正确的函数类型，覆盖promisify的错误推断
const asyncPipeline: (...streams: Stream[]) => Promise<void> = promisify(pipeline);

await asyncPipeline(
  file.stream,
  fs.createWriteStream(`${__dirname}${uploaderConfig.savePath}${fileName}`)
);

为什么会出现这个警告？ #

这个问题出在TypeScript对util.promisify的类型推断上。原生的stream.pipeline签名支持可变数量的流参数，最后再跟一个回调函数：

pipeline(...streams: Stream[], callback: (err?: Error) => void): void

但util.promisify的类型定义在处理这种可变参数+回调的函数时，没有正确推断出“去掉回调后保留可变参数”的签名，反而错误地生成了“只接受一个数组参数”的类型，导致IDEA提示参数数量不匹配。

不过你不用担心运行时问题——util.promisify在运行时是正确处理可变参数的，只是TypeScript的类型定义没跟上，所以我们要么用官方原生Promise版，要么手动修正类型即可。

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