Path Watcher Node Module
Installing
npm install pathwatcher
Building
- Clone the repository
- Run
npm install
- Run
grunt
to compile the CoffeeScript and native code - Run
npm test
to run the specs
Using
PathWatcher = require 'pathwatcher'
PathWatcher.watch(filename, [listener])
Watch for changes on filename
, where filename
is either a file or a
directory. The returned object is a PathWatcher.
The listener callback gets two arguments (event, path)
. event
is 'rename',
'delete' or 'change', and path
is the path of the file which triggered the
event.
For directories, the 'change' event is emitted when a file or directory under
the watched directory got created or deleted. And the PathWatcher.watch
is
not recursive, so changes of subdirectories under the watched directory would
not be detected.
PathWatcher.close()
Stop watching for changes on the given PathWatcher
.