【Node.js24.x】Object::WritableStreamDefaultController()メソッドの使い方

WritableStreamDefaultControllerメソッドは、Node.jsのWritableStreamにおいて、ストリームの内部的なデータ書き込み処理を制御し、管理する機能を提供するために使用されるメソッドです。厳密には、WritableStreamDefaultControllerはWritableStreamのコンストラクタに渡されるstartやwriteといったコールバック関数に引数として提供される「コントローラーオブジェクト」そのものですが、その役割はストリームの動作を「実行」し、調整するメソッド群を内包しています。

このコントローラーを通じて、開発者はストリームの現在の状態を監視し、書き込み可能な領域（キュー）のサイズを管理したり、ストリームの停止状態やエラー発生などの重要な状態変化を判断したりすることが可能です。具体的には、error()メソッドを呼び出してストリームにエラーを通知したり、signalプロパティを通じてアボートシグナルにアクセスしたりすることで、ストリームのライフサイクルにおける重要な決定を行うことができます。これにより、ストリームのバックプレッシャーを適切に処理し、非同期的なデータ書き込みを効率的に行い、システムリソースの過負荷を防ぐことができます。結果として、堅牢で安定したデータ転送を実現し、アプリケーション全体の信頼性とパフォーマンス向上に貢献します。

Copy
1const myWritableStream = new WritableStream({
2  write(chunk, controller) {
3    // データを内部キューに追加します
4    controller.enqueue(chunk);
5
6    // ストリームをエラー状態にします
7    controller.error(new Error('書き込み中にエラーが発生しました。'));
8
9    // 内部キューの推奨される空き容量を取得します
10    const desiredSize = controller.desiredSize;
11
12    // ストリームの中止シグナルを取得します
13    const abortSignal = controller.signal;
14  },
15  // 他のオプション（start, close）は省略
16});

引数なし

引数はありません

戻り値なし

戻り値はありません