関数の概要
fs.createReadStreamは、Node.jsでファイルを読み取るための関数です。主な目的は、大きなファイルを効率的に読み込むことにあります。ファイルを一度にまるごとメモリに読み込むのではなく、小さなチャンク(塊)に分割して読み込むため、大容量のファイルにも適しています。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
path | String | 読み込むファイルのパスを指定 |
options | Object | 読み込みオプションを指定(例:エンコーディング、高水準のストリームオプションなど) |
戻り値
fs.createReadStreamはReadStreamオブジェクトを返します。非同期的にファイルを読み込むため、コールバック関数を使用してデータを処理することが一般的です。
使用例
例1:
const fs = require('fs');
const readStream = fs.createReadStream('example.txt');
readStream.on('data', (chunk) => {
console.log(chunk);
});
例2:
const fs = require('fs');
const readStream = fs.createReadStream('example.txt', { encoding: 'utf8' });
readStream.pipe(process.stdout);
関連する関数
fs.createWriteStream:ファイルにデータを書き込むための関数
まとめ
fs.createReadStreamは大容量のファイルを効率的に読み込むための便利な関数です。適切なオプションを指定することで、ファイルの読み込みをカスタマイズすることができます。ただし、適切なエラーハンドリングを行うことで、ファイルの読み込み中に発生するエラーに対処する必要があります。