【Node.js24.x】Object::unwatchFile()メソッドの使い方

unwatchFileメソッドは、Node.jsのファイルシステムモジュール（fsモジュール）において、特定のファイルの監視を停止するメソッドです。これは、以前にfs.watchFileメソッドで開始されたファイル監視を解除するために使用されます。

fs.watchFileメソッドは、指定されたファイルに変更がないかを定期的に確認（ポーリング）することでファイルを監視し、変更があった場合に登録されたイベントリスナーを呼び出します。unwatchFileメソッドは、この定期的な監視プロセスとそのファイルに関連付けられたすべてのイベントリスナーを解除します。

このメソッドは主に一つの引数を受け取ります。それは監視を停止したいファイルのパスを示す文字列（filename）です。オプションとして、特定のイベントリスナー関数（listener）を指定することもできます。listenerが指定された場合、そのファイルパスに登録されたlistener関数のみが解除されます。listenerが指定されない場合、そのファイルパスに対してfs.watchFileで登録されたすべてのイベントリスナーが解除され、ファイルの監視が完全に停止されます。

ファイルを監視し続けると、システムリソース（CPUサイクルなど）を継続的に消費するため、不要になった監視はunwatchFileメソッドを使用して適切に停止することが推奨されます。これにより、アプリケーションのパフォーマンスと効率性を維持することができます。unwatchFileメソッドは、アプリケーションが不要なファイル監視リソースを解放し、システムの負荷を軽減するために重要な役割を果たします。

Copy
1import * as fs from 'node:fs';
2
3fs.unwatchFile('path/to/your/file.txt');

filename, listener

• filename: string: 監視を停止したいファイルのパス
• listener: Function: fs.watchFile で登録された、ファイル変更時に呼び出されるコールバック関数

戻り値なし

戻り値はありません