【Node.js24.x】Object::readFileSync()メソッドの使い方
readFileSyncメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
readFileSyncメソッドは、Node.jsのファイルシステム（fs）モジュールが提供する、ファイルの内容を同期的に読み込むメソッドです。このメソッドを実行すると、ファイルからのデータ読み込みが完了するまで、プログラムの他の処理は一時的に停止します。
メソッドの引数には読み込みたいファイルのパスを指定し、オプションとして文字エンコーディング（例：'utf8'）も指定できます。エンコーディングを指定するとファイル内容は文字列で、指定しない場合はBufferオブジェクトとして戻り値で返されます。
このメソッドは、プログラム起動時の設定ファイル読み込みなど、実行を一時停止しても問題ない用途に適しています。しかし、大量のファイル操作や高応答性が求められるWebサーバーのようなアプリケーションにおいては、同期処理がパフォーマンスに影響を与える可能性があるため、非同期版のfs.readFileメソッドの利用が推奨されます。ファイルが見つからない、読み取り権限がないなどのエラーも発生し得るため、適切なエラーハンドリングの実装が重要です。
構文(syntax)
1const fs = require('fs'); 2const fileContent = fs.readFileSync('path/to/file.txt', 'utf8');
引数(parameters)
path, options
- path: string: 読み込むファイルのパス
- options: object: ファイルの読み込み方法を指定するオプションオブジェクト
戻り値(return)
Buffer | string
指定されたエンコーディングやオプションによって、ファイルの内容をバッファまたは文字列として返します。