Node.js stream.addAbortSignal(signal, stream)用法及代码示例

stream.addAbortSignal(signal, stream)

参数

• signal <AbortSignal> 表示可能取消的信号
• stream <Stream> 将信号附加到的流

将 AbortSignal 附加到可读或可写流。这允许代码使用 AbortController 控制流销毁。

在对应于传递的 AbortSignal 的 AbortController 上调用 abort 的行为方式与在流上调用 .destroy(new AbortError()) 的方式相同。

const fs = require('node:fs');

const controller = new AbortController();
const read = addAbortSignal(
  controller.signal,
  fs.createReadStream(('object.json'))
);
// Later, abort the operation closing the stream
controller.abort();

或者使用带有可读流的AbortSignal 作为异步迭代：

const controller = new AbortController();
setTimeout(() => controller.abort(), 10_000); // set a timeout
const stream = addAbortSignal(
  controller.signal,
  fs.createReadStream(('object.json'))
);
(async () => {
  try {
    for await (const chunk of stream) {
      await process(chunk);
    }
  } catch (e) {
    if (e.name === 'AbortError') {
      // The operation was cancelled
    } else {
      throw e;
    }
  }
})();