fs.watchFile

関数の概要

fs.watchFileは、Node.jsのファイルシステム(fs)モジュールに含まれる関数で、特定のファイルの変更を監視するために使用されます。ファイルが変更されるたびにコールバック関数が呼び出されるため、ファイルの更新をリアルタイムで検知することができます。

パラメータの説明

引数 用途
filename string 監視するファイルのパス
options Object オプション設定(persistent、interval)
listener function ファイル変更時に呼び出されるコールバック関数

戻り値

fs.watchFileは戻り値を返さず、非同期的にファイルの変更を監視します。

使用例

例1:ファイルの変更を監視し、コンソールにメッセージを出力する


const fs = require('fs');

fs.watchFile('example.txt', (curr, prev) => {
  console.log('File changed');
});

例2:特定のファイルの変更を監視し、別の処理を実行する


const fs = require('fs');

fs.watchFile('data.json', (curr, prev) => {
  // ファイルの内容を読み込んで処理する
});

関連する関数

fs.watch、fs.watchFile、fs.unwatchFile

まとめ

fs.watchFileはファイルの変更を監視するための便利な関数です。リアルタイムでファイルの変更を検知できるため、自動的に処理を実行したい場合などに活用できます。ただし、過度に使用するとパフォーマンスに影響が出る可能性があるため、注意が必要です。