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

WriteStreamメソッドは、Node.js環境において、データを出力先へ効率的に書き込むためのストリームを管理するWriteStreamオブジェクトを生成し、その機能を提供するメソッドです。このメソッドを通じて、ファイルやネットワーク接続など、様々な出力先に対してデータを少しずつ書き込むための仕組みを確立できます。具体的には、大量のログデータをファイルに記録したり、ネットワークを通じてデータを送信したりする際に、メモリを効率的に使用しながら安定したデータ出力処理を実現することが目的です。生成されたWriteStreamオブジェクトを使用することで、データの書き込みを開始し、書き込み完了を検知したり、書き込み中に発生したエラーを処理したりする一連の操作が可能になります。システムエンジニアを目指す初心者の方にとっては、大きなデータを扱う際にアプリケーションのパフォーマンスを維持し、安定したデータ転送を行うための基盤となる重要な概念として理解することが大切です。

Copy
1const fs = require('node:fs');
2
3// 指定されたパスにファイル書き込みストリームを作成します。
4const fileStream = fs.createWriteStream('./example.txt');
5
6// ストリームにデータを書き込みます。
7fileStream.write('Hello, Node.js!\n');
8fileStream.write('This is an example of WriteStream.');
9
10// ストリームの書き込みを終了し、ファイルを閉じます。
11fileStream.end();

path, options = {}

• path: string: 作成するストリームのファイルパス
• options: object = {}: ストリームの動作を制御するためのオプションオブジェクト

WriteStream

Object.prototype.WriteStream メソッドは、ファイルへの書き込みストリームを表す WriteStream オブジェクトを返します。