【Node.js24.x】Stream::duplexPair()メソッドの使い方
duplexPairメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
duplexPairメソッドは、Node.jsのStreamモジュールに属し、二つのDuplexストリームのペアを生成するメソッドです。このメソッドを呼び出すと、内部で相互に接続された二つのDuplexストリームインスタンスが返されます。生成されたペアのストリームは、一方がデータを書き込むと、もう一方がそのデータを読み取れるという特性を持ちます。これにより、同一のNode.jsプロセス内で双方向のデータ通信経路を簡単に確立できます。
具体的には、一つ目のストリームの書き込み可能端にデータを送信すると、それが自動的に二つ目のストリームの読み込み可能端から利用可能となり、その逆も同様です。この機能は、アプリケーションの異なる部分間でストリームを介した通信を行いたい場合や、ストリームベースのコンポーネントをテストするシナリオで非常に有用です。例えば、カスタムのデータ変換ロジックをテストする際に、実際の入出力なしにストリームの振る舞いをシミュレートするために利用できます。オプションを指定することで、生成されるDuplexストリームの挙動を細かく制御することも可能です。
構文(syntax)
1const { socket, readable } = require('stream').duplexPair();
引数(parameters)
options = {}
- options: object: Stream.DuplexPairOptions: オプションを指定するオブジェクト
戻り値(return)
{ socket1: stream.Duplex, socket2: stream.Duplex }
Stream.duplexPair() メソッドは、双方向のストリームとして機能する2つの stream.Duplex オブジェクトを含むオブジェクトを返します。これらのストリームは互いに通信可能であり、一方に書き込まれたデータはもう一方から読み取ることができます。