Node.js new stream.Duplex(options)用法及代码示例

new stream.Duplex(options)

参数

• options <Object>传给双方Writable和Readable构造函数。还具有以下字段：
  • allowHalfOpen <boolean> 如果设置为 false ，则当可读端结束时，流将自动结束可写端。 默认： true 。
  • readable <boolean> 设置Duplex 是否可读。 默认： true 。
  • writable <boolean> 设置Duplex 是否应可写。 默认： true 。
  • readableObjectMode <boolean> 为流的可读端设置objectMode。如果 objectMode 是 true 则无效。 默认： false 。
  • writableObjectMode <boolean> 将objectMode 设置为流的可写侧。如果 objectMode 是 true 则无效。 默认： false 。
  • readableHighWaterMark <number> 为流的可读端设置highWaterMark。如果提供了highWaterMark，则无效。
  • writableHighWaterMark <number> 为流的可写端设置highWaterMark。如果提供了highWaterMark，则无效。

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

class MyDuplex extends Duplex {
  constructor(options) {
    super(options);
    // ...
  }
}

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

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

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

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

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

const myDuplex = new Duplex({
  read(size) {
    // ...
  },
  write(chunk, encoding, callback) {
    // ...
  }
});

使用管道时：

const { Transform, pipeline } = require('node:stream');
const fs = require('node:fs');

pipeline(
  fs.createReadStream('object.json')
    .setEncoding('utf8'),
  new Transform({
    decodeStrings: false, // Accept string input rather than Buffers
    construct(callback) {
      this.data = '';
      callback();
    },
    transform(chunk, encoding, callback) {
      this.data += chunk;
      callback();
    },
    flush(callback) {
      try {
        // Make sure is valid json.
        JSON.parse(this.data);
        this.push(this.data);
        callback();
      } catch (err) {
        callback(err);
      }
    }
  }),
  fs.createWriteStream('valid-object.json'),
  (err) => {
    if (err) {
      console.error('failed', err);
    } else {
      console.log('completed');
    }
  }
);