関数の概要
fs.createWriteStreamは、Node.jsのファイルシステムモジュールで提供される関数です。この関数は、指定されたファイルに書き込み可能なストリームを作成します。主な目的は、ファイルへのデータの書き込みを非同期で行うことです。
パラメータの説明
| 引数 | 型 | 用途 |
|---|---|---|
| path | String | 書き込み先のファイルパスを指定する |
| options | Object | 書き込みオプションを指定する（例: {flags: ‘a’}） |
戻り値
fs.createWriteStreamはWritable Streamオブジェクトを返します。このオブジェクトは非同期で書き込みを行うため、コールバック関数を使用して書き込みの完了をハンドリングする必要があります。
使用例
ファイルにテキストを書き込む例：
const fs = require('fs');
const writeStream = fs.createWriteStream('output.txt');
writeStream.write('Hello, World!');
ストリームにデータを流しながら書き込む例：
const fs = require('fs');
const writeStream = fs.createWriteStream('output.txt');
writeStream.write('Hello, ');
writeStream.write('World!');
関連する関数
- fs.createReadStream: 読み込み可能なストリームを作成する
- fs.writeFile: ファイル全体を非同期的に書き込む
まとめ
fs.createWriteStreamは、ファイルに非同期で書き込みを行うための便利な関数です。適切に使用することで、効率的にファイルにデータを書き込むことができます。ただし、コールバック関数を適切に処理することが重要です。
