如何捕获TypeScript/Node.js中函数输出到终端的内容

在Node.js环境中，终端输出本质是写入process.stdout（对应console.log）和process.stderr（对应console.error）流。要捕获这些输出，你可以临时重定向这两个流的写入方法，在函数执行期间收集输出内容，执行完成后恢复原流即可。

同步函数的捕获实现 #

先封装一个通用的捕获工具函数，用于包裹目标函数执行：

type CaptureResult = {
  stdout: string;
  stderr: string;
};

/**
 * 捕获函数执行期间的所有stdout和stderr输出
 * @param fn 要执行的目标函数
 * @returns 包含捕获到的输出和函数返回值的对象
 */
function captureConsoleOutput<T>(fn: () => T): CaptureResult & { result: T } {
  // 保存原始的写入方法
  const originalStdoutWrite = process.stdout.write;
  const originalStderrWrite = process.stderr.write;
  
  let stdoutBuffer = '';
  let stderrBuffer = '';

  // 重定向stdout的写入逻辑
  process.stdout.write = (chunk: string | Buffer) => {
    stdoutBuffer += chunk.toString();
    return true; // 模拟原方法的返回值（表示写入成功）
  } as typeof process.stdout.write;

  // 重定向stderr的写入逻辑
  process.stderr.write = (chunk: string | Buffer) => {
    stderrBuffer += chunk.toString();
    return true;
  } as typeof process.stderr.write;

  let functionResult: T;
  try {
    // 执行目标函数
    functionResult = fn();
  } finally {
    // 必须恢复原始流，避免影响后续代码的输出
    process.stdout.write = originalStdoutWrite;
    process.stderr.write = originalStderrWrite;
  }

  return {
    stdout: stdoutBuffer,
    stderr: stderrBuffer,
    result: functionResult
  };
}

使用示例 #

针对你的目标函数func，可以这样捕获输出：

// 你的目标函数
function func(param1: string, param2: string, param3: string) {
  console.log(`参数接收：${param1}, ${param2}, ${param3}`);
  if (param1 === 'invalid') {
    console.error('参数不合法！');
  }
}

// 捕获输出
const { stdout, stderr } = captureConsoleOutput(() => {
  func('param1', 'param2', 'param3');
});

// 后续逻辑判断
console.log('捕获到的标准输出：', stdout);
console.log('捕获到的错误输出：', stderr);

// 根据输出做条件判断
if (stderr.includes('参数不合法')) {
  console.log('触发错误处理逻辑');
}

异步函数的捕获实现 #

如果目标函数是异步的（返回Promise），可以修改工具函数支持async/await：

async function captureConsoleOutputAsync<T>(fn: () => Promise<T>): Promise<CaptureResult & { result: T }> {
  const originalStdoutWrite = process.stdout.write;
  const originalStderrWrite = process.stderr.write;
  
  let stdoutBuffer = '';
  let stderrBuffer = '';

  process.stdout.write = (chunk: string | Buffer) => {
    stdoutBuffer += chunk.toString();
    return true;
  } as typeof process.stdout.write;

  process.stderr.write = (chunk: string | Buffer) => {
    stderrBuffer += chunk.toString();
    return true;
  } as typeof process.stderr.write;

  let functionResult: T;
  try {
    functionResult = await fn();
  } finally {
    process.stdout.write = originalStdoutWrite;
    process.stderr.write = originalStderrWrite;
  }

  return {
    stdout: stdoutBuffer,
    stderr: stderrBuffer,
    result: functionResult
  };
}

// 异步函数调用示例
async function asyncFunc(param: string) {
  return new Promise(resolve => {
    setTimeout(() => {
      console.log(`异步处理完成：${param}`);
      resolve();
    }, 100);
  });
}

// 使用异步捕获
(async () => {
  const { stdout } = await captureConsoleOutputAsync(() => asyncFunc('test'));
  console.log('捕获到的异步输出：', stdout);
})();

注意事项 #

• 该方法会捕获所有在函数执行期间的流输出，包括其他模块的console调用，若需精准捕获目标函数的输出，需确保执行期间无其他无关输出。
• 必须在finally块中恢复原始流，否则后续代码的终端输出会失效。
• 如果函数直接调用process.stdout.write或process.stderr.write，该方法依然能捕获到输出，比直接替换console.log/console.error的方式更全面。

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