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();