A globbing fs.watch wrapper built from the best parts of other fine watch libs.
Compatible with Node.js >= 4.x, Windows, macOS, and Linux.
Usage
Install the module with: npm install gaze or place into your package.json
and run npm install.
var gaze = require('gaze');// Watch all .js files/dirs in process.cwd()gaze('**/*.js', function(err, watcher) { // Files have all started watching // watcher === this // Get all watched files var watched = this.watched(); // On file changed this.on('changed', function(filepath) { console.log(filepath + ' was changed'); }); // On file added this.on('added', function(filepath) { console.log
Alternate Interface
var Gaze = require('gaze').Gaze;var gaze = new Gaze('**/*');// Files have all started watchinggaze.on('ready', function(watcher) { });// A file has been added/changed/deleted has occurredgaze.on('all', function(event, filepath) { });
Errors
gaze('**/*', function(error, watcher) { if (error) { // Handle error if it occurred while starting up }});// Or with the alternative interfacevar gaze = new Gaze();gaze.on('error', function(error) { // Handle error here});gaze.add('**/*');
In lieu of a formal styleguide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Lint and test your code
using grunt.
Release History
1.1.3 - Fix for Node 10 support (@aredridel). Officially dropping support for Node < 4.
1.1.2 - Prevent more ENOENT errors from escaping (@alexgorbatchev).
1.1.1 - Prevent fs.watch errors from escaping error handler (@rosen-vladimirov). Fix _addToWatched without path.sep (@wyicwx).
1.1.0 - Update to globule@1.0.0 with minimatch >= 3.0.0.
1.0.0 - Revert back to 0.5.2. Drop support for Node.js v0.8. Fix for maxListeners. Update globule to 0.2.0.
0.6.4 - Catch and emit error from readdir (@oconnore). Fix for 0 maxListeners. Use graceful-fs to avoid EMFILE errors in other places fs is used. Better method to determine if pathwatcher was built. Fix keeping process alive too much, only init pathwatcher if a file is being watched. Set min required to Windows Vista when building on Windows (@pvolok).
0.6.3 - Add support for Node.js v0.11
0.6.2 - Fix argument error with watched(). Fix for erroneous added events on folders. Ignore msvs build error 4244.
0.6.1 - Fix for absolute paths.
0.6.0 - Uses native OS events (fork of pathwatcher) but can fall back to stat polling. Everything is async to avoid blocking, including relative() and watched(). Better error handling. Update to globule@0.2.0. No longer watches cwd by default. Added mode option. Better EMFILE message. Avoids ENOENT errors with symlinks. All constructor arguments are optional.
0.5.2 - Fix for ENOENT error with non-existent symlinks [BACKPORTED].
0.5.1 - Use setImmediate (process.nextTick for Node.js v0.8) to defer ready/nomatch events (@amasad).
0.5.0 - Process is now kept alive while watching files. Emits a nomatch event when no files are matching.
0.4.3 - Track file additions in newly created folders (@brett-shwom).
0.4.2 - Fix .remove() method to remove a single file in a directory (@kaelzhang). Fixing “” (@krasimir). Track new file additions within folders (@brett-shwom).
License
Copyright (c) 2018 Kyle Robinson Young
Licensed under the MIT license.
0.4.1 - Fix watchDir not respecting close in race condition (@chrisirhc).
0.4.0 - Drop support for Node.js v0.6. Use globule for file matching. Avoid Node.js v0.10 path.resolve/join errors. Register new files when added to non-existent folder. Multiple instances can now poll the same files (@jpommerening).
0.3.4 - Code clean up. Fix “path must be strings” errors (@groner). Fix incorrect added events (@groner).
0.3.3 - Fix for multiple patterns with negate.
0.3.2 - Emit end before removeAllListeners.
0.3.1 - Fix added events within subfolder patterns.