【Node.js24.x】Object::ReadStream()メソッドの使い方
ReadStreamメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
ReadStreamメソッドは、Node.jsにおいて、ファイルやネットワークからデータを読み込むストリーム処理を行うための機能を提供するメソッドです。このメソッドは、大量のデータを効率的かつメモリ使用量を抑えながら非同期的に処理するメカニズムを提供します。具体的には、データ全体を一度にメモリにロードするのではなく、データを小さなチャンク(塊)に分割して順次読み込み、処理していくことが可能です。これにより、アプリケーションはデータの読み込みが完了するのを待つことなく、他の処理を進めることができ、システムの応答性を向上させます。ReadStreamメソッドは、通常、fs.createReadStream()のようなファクトリ関数によってReadStreamクラスのインスタンスを生成する際に利用される機能として関連付けられます。システムエンジニアを目指す方にとって、ReadStreamはNode.jsにおける非同期I/Oやデータストリーミングの基礎を理解するための重要な概念です。
構文(syntax)
1const fs = require('fs'); 2 3const fileStream = fs.createReadStream('path/to/your/file.txt', { encoding: 'utf8' }); 4 5fileStream.on('data', (chunk) => { 6 console.log(`Received data chunk of ${chunk.length} bytes`); 7}); 8 9fileStream.on('end', () => { 10 console.log('Finished reading the file.'); 11}); 12 13fileStream.on('error', (err) => { 14 console.error('An error occurred:', err); 15});
引数(parameters)
path, options
- path: string: 読み込むファイルへのパス
- options: object = {}: ファイル読み込みに関するオプションを指定するオブジェクト
戻り値(return)
fs.ReadStream
fs.createReadStream() メソッドは、指定されたパスからデータを読み込むための fs.ReadStream オブジェクトを返します。このオブジェクトは、ストリームとしてデータを非同期に処理するために使用できます。