Watching files in node.js is a total nightmare. Chokidar makes the whole experience much less painful, but it's not foolproof - I've often encountered
EMFILE (too many open files) errors when using it to watch large directories.
This fork simply replaces
require('graceful-fs'). graceful-fs is a drop-in replacement for the native
fs that prevents
EMFILE errors from occurring. It also removes the optional dependency on
fsevents (the native filesystem events binding), because I've experienced segmentation faults while using it.
Other than that, nothing has changed, and full credit belongs to Paul Miller.
In theory, using graceful-fs should entail a performance hit. In practice, you won't notice it - my experience is that it's every bit as fast and reliable as the original Chokidar, except that you don't hit
A neat wrapper around node.js fs.watch / fs.watchFile.
Other node.js watching libraries:
Chokidar resolves these problems.
Install chokidar via node.js package manager:
npm install chokidar
Then just require the package in your code:
var chokidar = ;var watcher = chokidar;watcher// 'add', 'addDir' and 'change' events also receive stat() results as second argument.//watcher;watcher;watcher;// Only needed if watching is persistent.watcher;// One-liner;
chokidar.watch(paths, options): takes paths to be watched recursively and options:
options.ignored(regexp or function) files to be ignored. This function or regexp is tested against the whole path, not just filename. If it is a function with two arguments, it gets called twice per path - once with a single argument (the path), second time with two arguments (the path and the
fs.Statsobject of that path).
false). Indicates whether the process should continue to run as long as files are being watched.
false). Indicates whether to watch files that don't have read permissions.
false). Indicates whether chokidar should ignore the initial
addevents or not.
100). Interval of file system polling.
300). Interval of file system polling for binary files (see extensions in src/is-binary).
trueon Linux and OS X). Whether to use fs.watchFile (backed by polling), or fs.watch. If polling leads to high CPU utilization, consider setting this to
chokidar.watch() produces an instance of
FSWatcher. Methods of
.add(file / files): Add directories / files for tracking. Takes an array of strings (file paths) or just one path.
.on(event, callback): Listen for an FS event. Available events:
allis available which gets emitted for every
.close(): Removes all listeners from watched files.
The MIT license.
Copyright (c) 2013 Paul Miller (http://paulmillr.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.