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

new stream.Writable([options])

参数

• options <Object>
  • highWaterMark <number> stream.write() 开始返回 false 时的缓冲区级别。 默认： 16384 (16 KiB)，或 16 用于 objectMode 流。
  • decodeStrings <boolean> 是否将传递给 stream.write() 的 string 编码为 Buffer (使用在 stream.write() 调用中指定的编码)，然后再将它们传递给 stream._write() 。其他类型的数据不会被转换(即 Buffer s 不会被解码为 string s)。设置为 false 将阻止 string 被转换。 默认： true 。
  • defaultEncoding <string> 未指定编码时使用的默认编码作为 stream.write() 的参数。 默认： 'utf8' 。
  • objectMode <boolean> stream.write(anyObj) 是否为有效操作。设置后，如果流实现支持，则可以写入除字符串、Buffer 或 Uint8Array 之外的 JavaScript 值。 默认： false 。
  • emitClose <boolean> 流被销毁后是否应该发出 'close'。 默认： true 。
  • write <Function> stream._write() 方法的实现。
  • writev <Function> stream._writev() 方法的实现。
  • destroy <Function> stream._destroy() 方法的实现。
  • final <Function> stream._final() 方法的实现。
  • construct <Function> stream._construct() 方法的实现。
  • autoDestroy <boolean> 此流是否应在结束后自动调用自身的.destroy()。 默认： true 。
  • signal <AbortSignal> 表示可能取消的信号。

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

class MyWritable extends Writable {
  constructor(options) {
    // Calls the stream.Writable() constructor.
    super(options);
    // ...
  }
}

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

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

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

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

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

const myWritable = new Writable({
  write(chunk, encoding, callback) {
    // ...
  },
  writev(chunks, callback) {
    // ...
  }
});

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

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

const controller = new AbortController();
const myWritable = new Writable({
  write(chunk, encoding, callback) {
    // ...
  },
  writev(chunks, callback) {
    // ...
  },
  signal: controller.signal
});
// Later, abort the operation closing the stream
controller.abort();