Node.js：如何返回可读流同时通过Promise完成文件写入？

核心思路 #

不要在download函数内等待pipeline执行完成，让文件写入操作在后台异步运行，同时直接返回可读流source。需要注意处理pipeline的错误，避免未捕获异常导致进程崩溃。

实现方案1：基础版（后台执行写入） #

const { pipeline } = require('stream/promises');
const fs = require('fs');

function download() {
  const source = createReadStreamSomeHow();
  
  // 启动管道写入，不阻塞函数返回
  pipeline(source, fs.createWriteStream("file.ext"))
    .catch(err => {
      console.error('文件写入失败:', err);
      // 给source发射自定义错误事件，供调用方监听
      source.emit('writeError', err);
    })
    .then(() => {
      console.log('文件写入完成');
      source.emit('writeFinish');
    });

  return source;
}

调用方式：

const task = download();
taskArray.add(task);

// 可选：监听写入状态
task.on('writeFinish', () => {
  console.log('该流的文件写入已完成');
});

task.on('writeError', (err) => {
  console.error('写入出错:', err);
});

实现方案2：附加Promise跟踪写入状态 #

如果需要后续主动等待写入完成，可以把pipeline的Promise附加到source上，提升灵活性：

function download() {
  const source = createReadStreamSomeHow();
  
  // 用Promise包装pipeline，方便后续跟踪写入状态
  source.writePromise = pipeline(source, fs.createWriteStream("file.ext"));

  return source;
}

调用方式：

const task = download();
taskArray.add(task);

// 后续如果需要等待该流的写入完成：
// await task.writePromise;

// 捕获写入错误
task.writePromise.catch(err => {
  console.error('写入失败:', err);
});

关键说明 #

1. 移除await pipeline后，函数会立刻返回source，写入操作在后台异步执行
2. 必须处理pipeline的错误：无论用回调还是Promise的catch，否则未捕获的错误会导致进程退出
3. 通过自定义事件或附加Promise，让调用方可以灵活跟踪写入的完成/错误状态

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