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

isWritableメソッドは、Node.jsのStreamオブジェクトが現在データを書き込むことが可能な状態にあるかを確認するメソッドです。このメソッドは、ストリームがデータを受け付ける準備ができているかどうかを真偽値で返します。具体的には、ストリームが初期化され、書き込み操作を受け付ける状態にある場合や、まだ閉じられていない状態を示す場合にtrueを返します。それ以外の、例えばエラーが発生したり、ストリームが完全に閉じられたりした場合にはfalseを返します。

このメソッドの重要な点は、writable.end()メソッドが呼び出された後でも、内部バッファにまだ書き込み待ちのデータが残っている状況ではtrueを返す可能性があることです。writable.end()は、これ以上データが書き込まれないことをストリームに通知するものであり、ストリームが即座に閉じられ、すべてのデータ処理が完了することを意味するわけではありません。したがって、ストリームの全ての書き込みが完了し、内部バッファも空になっていることを確認したい場合は、writableFinishedプロパティを参照するなど、他のアプローチが必要になります。

isWritableは、ストリームが追加のデータを書き込むことができるかどうか、またはストリームの現在の書き込み状態を把握するために利用されます。Node.js 24において、ストリームのライフサイクルと状態管理を理解する上で役立つメソッドの一つです。これにより、開発者はストリームに対する安全な書き込み操作を判断し、予期せぬエラーを防ぐことができます。

Copy
1const { isWritable } = require('stream');
2const fs = require('fs');
3
4const myWritableStream = fs.createWriteStream('./temp.txt');
5const canWrite = isWritable(myWritableStream);
6console.log(canWrite);

stream

• stream: Stream: チェック対象のストリームオブジェクト

boolean

Streamインスタンスが書き込み可能かどうかを示します。書き込み可能な場合はtrue、そうでない場合はfalseを返します。