Now it's fast to watch deep directories on macOS and Windows, since the recursive option is natively supported except on Linux.
// watch the whole diskwatch('/', { recursive: true }, console.log);
Why?
Some editors will generate temporary files which will cause the callback function to be triggered multiple times.
The callback function will only be triggered once on watching a single file.
Missing an option to watch a directory recursively.
Recursive watch is not supported on Linux or in older versions of nodejs.
Keep it simple, stupid.
Options
The usage and options of node-watch are compatible with fs.watch.
persistent: Boolean (default true)
recursive: Boolean (default false)
encoding: String (default 'utf8')
Extra options
filter: RegExp | Function
Return that matches the filter expression.
// filter with regular expressionwatch('./', { filter: /\.json$/ });// filter with custom functionwatch('./', { filter: f => !/node_modules/.test(f) });
Each file and directory will be passed to the filter to determine whether
it will then be passed to the callback function. Like Array.filter does in JavaScript.
There are three kinds of return values for filter function:
true: Will be passed to callback.
false: Will not be passed to callback.
skip: Same with false, and skip to watch all its subdirectories.
On Linux, where the recursive option is not natively supported,
it is more efficient to skip ignored directories by returning the skip flag:
watch('./', {
Events
The events provided by the callback function is either update or remove, which is less confusing to fs.watch's rename or change.
watch('./', function(evt, name) { if (evt == 'update') { // on create or modify } if (evt == 'remove') { // on delete }});
Watcher object
The watch function returns a fs.FSWatcher like object as the same as fs.watch (>= v0.4.0).
Watcher events
let watcher = watch('./', { recursive: true });watcher.on('change', function(evt, name) { // callback});watcher.on('error', function(err) { // handle error});watcher.on('ready', function() { // the watcher is ready to respond to changes});
Close
// closewatcher.close();// is closed?watcher.isClosed()
List of methods
.on
.once
.emit
.close
.listeners
.setMaxListeners
.getMaxListeners
Extra methods
.isClosed detect if the watcher is closed
.getWatchedPaths get all the watched paths
Known issues
Windows, node < v4.2.5
Failed to detect remove event
Failed to get deleted filename or directory name
MacOS, node 0.10.x
Will emit double event if the directory name is of one single character.
Misc
1. Watch multiple files or directories in one place
If you get ENOSPC error, but you actually have free disk space - it means that your OS watcher limit is too low and you probably want to recursively watch a big tree of files.