stream.Duplex

関数の概要

stream.Duplexは、Node.jsで提供されるストリームの1つであり、読み込みと書き込みの両方が可能なストリームです。つまり、データを読み込んで処理し、その結果を出力する際に使用します。データを受け取りつつ同時にデータを送信するような処理に適しています。

パラメータの説明

パラメータ 用途
options Object ストリームの動作をカスタマイズするためのオプション

戻り値

stream.Duplexのインスタンスが返されます。このインスタンスは読み取り可能かつ書き込み可能なストリームであり、非同期的に操作されます。

使用例

以下にstream.Duplexの使用例を示します。


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

const myDuplexStream = new Duplex({
  write(chunk, encoding, callback) {
    console.log(chunk.toString().toUpperCase());
    callback();
  },
  read(size) {
    this.push('Hello, World!');
    this.push(null);
  }
});

関連する関数

stream.Duplexと関連する関数:

  • stream.Readable: 読み取り可能なストリームを扱う
  • stream.Writable: 書き込み可能なストリームを扱う

まとめ

stream.Duplexは読み込みと書き込みの両方が可能なストリームであり、データの受け渡しに使用されます。注意点として、適切にデータを読み書きするために、ストリームの挙動を正しく理解して利用する必要があります。