Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

FileWriteStreamメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

FileWriteStreamメソッドは、ファイルへデータを書き込むためのストリーム(データの流れ)を管理・実行するメソッドです。このメソッドは、指定されたファイルパスに対し、効率的にデータを書き込む機能を提供します。特に、サイズの大きなファイルを扱う際にその真価を発揮し、ファイル全体を一度にメモリに読み込んだり書き込んだりする必要がないため、システムのリソース消費を大幅に抑えることが可能です。

データの書き込み処理を小さなチャンク(塊)に分割し、順番にファイルへ送信することで、メモリ使用量を低減しつつ、安定したパフォーマンスで非同期的なファイル操作を実現します。これにより、アプリケーションが大量のデータを書き込んでいる間も、他の処理をブロックすることなく、応答性を維持することができます。

例えば、大量のログデータを継続的に記録する場合や、ネットワーク経由で受信した大きなファイルをディスクに保存する場合、データベースからエクスポートした結果をファイルに出力する場合など、様々なシナリオで活用されます。システムエンジニアを目指す方にとって、効率的なファイル操作は基本的なスキルの一つであり、FileWriteStreamメソッドはその理解を深める上で重要な概念となります。ファイルへの書き込みをストリームとして扱うことで、柔軟かつ高性能なデータ処理の基盤を築くことができるでしょう。

構文(syntax)

1const fs = require('node:fs');
2
3// FileWriteStream オブジェクトを生成する
4const fileWriteStream = fs.createWriteStream('output.txt');
5
6// データをファイルに書き込む
7fileWriteStream.write('これはファイルに書き込まれる最初の行です。\n');
8fileWriteStream.write('これは2番目の行です。\n');
9
10// 書き込みを終了し、ファイルを閉じる
11fileWriteStream.end('これは最後の行です。');

引数(parameters)

path, options = {}

  • path: string: 作成するファイルのパス
  • options: object: ファイル書き込みに関するオプション設定(省略可能)

戻り値(return)

fs.WriteStream

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

関連コンテンツ

関連プログラミング言語