glob-watcher

Watch globs and execute a function upon change, with intelligent defaults for debouncing and queueing.

Usage

1var watch = require('glob-watcher');
2
3watch(['./*.js', '!./something.js'], function (done) {
4  // This function will be called each time a globbed file is changed
5  // but is debounced with a 200ms delay (default) and queues subsequent calls
6
7  // Make sure to signal async completion with the callback
8  // or by returning a stream, promise, observable or child process
9  done();
10
11  // if you need access to the `path` or `stat` object, listen
12  // for the `change` event (see below)
13
14  // if you need to listen to specific events, use the returned
15  // watcher instance (see below)
16});
17
18// Raw chokidar instance
19var watcher = watch(['./*.js', '!./something.js']);
20
21// Listen for the 'change' event to get `path`/`stat`
22// No async completion available because this is the raw chokidar instance
23watcher.on('change', function (path, stat) {
24  // `path` is the path of the changed file
25  // `stat` is an `fs.Stat` object (not always available)
26});
27
28// Listen for other events
29// No async completion available because this is the raw chokidar instance
30watcher.on('add', function (path, stat) {
31  // `path` is the path of the changed file
32  // `stat` is an `fs.Stat` object (not always available)
33});

API

watch(globs[, options][, fn])

Takes a path string, an array of path strings, a glob string or an array of glob strings as globs to watch on the filesystem. Also optionally takes options to configure the watcher and a fn to execute when a file changes.

Note: As of 5.0.0, globs must use / as the separator character because \\ is reserved for escape sequences (as per the Bash 4.3 & Micromatch specs). This means you can't use path.join() or **dirnamein Windows environments. If you need to usepath.join(), you can use normalize-path against your paths afterwards. If you need to use **dirname, you can set it as the cwd option that gets passed directly to chokidar. The micromatch docs contain more information about backslashes.

Returns an instance of chokidar.

fn([callback])

If the fn is passed, it will be called when the watcher emits a change, add or unlink event. It is automatically debounced with a default delay of 200 milliseconds and subsequent calls will be queued and called upon completion. These defaults can be changed using the options.

The fn is passed a single argument, callback, which is a function that must be called when work in the fn is complete. Instead of calling the callback function, async completion can be signalled by:

• Returning a Stream or EventEmitter
• Returning a Child Process
• Returning a Promise
• Returning an Observable

Once async completion is signalled, if another run is queued, it will be executed.

options

options.ignoreInitial

If set to false the fn is called during chokidar instantiation as it discovers the file paths. Useful if it is desirable to trigger the fn during startup.

Passed through to chokidar, but defaulted to true instead of false.

Type: Boolean

Default: true

options.delay

The delay to wait before triggering the fn. Useful for waiting on many changes before doing the work on changed files, e.g. find-and-replace on many files.

Type: Number

Default: 200 (milliseconds)

options.queue

Whether or not a file change should queue the fn execution if the fn is already running. Useful for a long running fn.

Type: Boolean

Default: true

options.events

An event name or array of event names to listen for. Useful if you only need to watch specific events.

Type: String | Array<String>

Default: [ 'add', 'change', 'unlink' ]

other

Options are passed directly to chokidar.

License

MIT