Node.js new stream.Readable([options])用法及代码示例

new stream.Readable([options])

参数

• options <Object>
  • highWaterMark <number> 在停止从底层资源读取之前存储在内部缓冲区中的最大值 number of bytes。 默认： 16384 (16 KiB)，或 16 用于 objectMode 流。
  • encoding <string> 如果指定，则缓冲区将使用指定的编码解码为字符串。 默认： null 。
  • objectMode <boolean> 此流是否应表现为对象流。这意味着 stream.read(n) 返回单个值而不是大小为 n 的 Buffer 。 默认： false 。
  • emitClose <boolean> 流被销毁后是否应该发出 'close'。 默认： true 。
  • read <Function> stream._read() 方法的实现。
  • destroy <Function> stream._destroy() 方法的实现。
  • construct <Function> stream._construct() 方法的实现。
  • autoDestroy <boolean> 此流是否应在结束后自动调用自身的.destroy()。 默认： true 。
  • signal <AbortSignal> 表示可能取消的信号。

const { Readable } = require('node:stream');

class MyReadable extends Readable {
  constructor(options) {
    // Calls the stream.Readable(options) constructor.
    super(options);
    // ...
  }
}

或者，当使用 pre-ES6 风格的构造函数时：

const { Readable } = require('node:stream');
const util = require('node:util');

function MyReadable(options) {
  if (!(this instanceof MyReadable))
    return new MyReadable(options);
  Readable.call(this, options);
}
util.inherits(MyReadable, Readable);

或者，使用简化的构造方法：

const { Readable } = require('node:stream');

const myReadable = new Readable({
  read(size) {
    // ...
  }
});

在对应于传递的 AbortSignal 的 AbortController 上调用 abort 的行为方式与在创建的可读文件上调用 .destroy(new AbortError()) 的方式相同。

const { Readable } = require('node:stream');
const controller = new AbortController();
const read = new Readable({
  read(size) {
    // ...
  },
  signal: controller.signal
});
// Later, abort the operation closing the stream
controller.abort();