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

createWriteStreamメソッドは、指定されたファイルへの書き込みストリームを作成し、ファイルにデータを効率的に書き込む処理を実行するメソッドです。これはNode.jsのファイルシステム（fs）モジュールから提供される主要な機能の一つで、特に大きなファイルを扱う際にメモリ効率の良いデータ書き込みを実現するために用いられます。

このメソッドは、ファイルパスと任意のオプションオブジェクトを引数として受け取ります。そして、ファイルへの書き込み操作を行うためのWritableストリームのインスタンスを返します。このWritableストリームオブジェクトを通じて、開発者はwrite()メソッドを使用してデータのチャンク（断片）をファイルに順次書き込んだり、end()メソッドを呼び出して書き込み処理を完了させたりすることができます。ストリームベースの書き込みは、ファイル全体を一度にメモリに読み込む必要がないため、システムリソースを節約し、特に大規模なデータ処理においてアプリケーションのパフォーマンスを向上させる効果があります。

オプションオブジェクトでは、ファイルのエンコーディング形式、ファイルをオープンする際のフラグ（追記や上書きなど）、ファイルのパーミッションなど、詳細な設定を柔軟に行うことが可能です。createWriteStreamメソッドは、データを非同期で処理するため、ファイルへの書き込み中にアプリケーションの他の処理がブロックされることなく、スムーズな動作を維持できるという重要な利点があります。システムエンジニアとして、効率的なファイルI/O処理を実装するために不可欠なメソッドの一つです。

Copy
1const fs = require('node:fs');
2
3const writableStream = fs.createWriteStream('path/to/your/file.txt', { encoding: 'utf8', flags: 'w' });

path, options

• path: string: 書き込み先のファイルパスを指定します。
• options: object: 書き込みストリームのオプションを指定するオブジェクトです。

fs.WriteStream

Object.createWriteStream() メソッドは、指定されたファイルパスへの書き込みストリームを表す fs.WriteStream オブジェクトを返します。このオブジェクトを使用して、ファイルにデータを非同期で書き込むことができます。