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