miniwatch
v0.1.1
Published
Simple file/directory watcher library with a simple API.
Downloads
5
Readme
Simple file/directory watcher library with a simple API
You can watch a directory for file changes using the well-known (error, result)
callback pattern. The events are throttled, so you can optimize your event handling for a bunch of simultaneous file changes. All the initial files, currently in the watched directory, are also reported as created. So you don't have to glob
yourself.
API:
miniwatch(options, callback)
with the following options:directory
: string, the directory path you want to watch for changesinclude
: string, glob pattern of files to include (default all)exclude
: string, glob pattern of files to exclude (default none)
miniwatch(directory, callback)
, shorthand if you want to watch all files
Simple example:
miniwatch('my-dir', function(error, files) {
console.log(files);
});
Verbose example:
miniwatch({
directory: __dirname + '/site',
include: '**/*.js',
exclude: '**/*.bundle.js'
}, function(error, files) {
if (error) throw error;
if (files.deleted) {
files.deleted.forEach(function(file) {
bundler.remove(file);
});
}
if (files.updated) {
files.updated.forEach(function(file) {
bundler.reload(file);
});
}
if (files.created) {
files.created.forEach(function(file) {
bundler.add(file);
});
}
});
Install:
npm install miniwatch