pathwatcher

Path Watcher Node Module

Showing:

Popularity

Downloads/wk

932

GitHub Stars

91

Maintenance

Last Commit

3mos ago

Contributors

38

Package

Dependencies

8

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Path Watcher Node module

ci Depenency Status

Installing

npm install pathwatcher

Building

  • Clone the repository
  • Run npm install to install the dependencies
  • 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 can be 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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100