wi

watch.io

An event wrapper for fs.watch(), with support for recursive directories

Showing:

Popularity

Downloads/wk

4

Maintenance

No Maintenance Data Available

Package

Dependencies

0

Size (min+gzip)

0.8KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Watch.IO

NPM version Build status

An event wrapper for fs.watch(), with support for recursive directories.

Caution

The fs.watch() API is not 100% consistent across platforms, and is unavailable and less reliable in some situations.

Due to the behavior of fs.watch(), if you want to read the updated file content in the event listener, please delay a few milliseconds manually.

Installation

npm install watch.io

Quickstart

The WatchIO object inherits events.EventEmitter, so use it in an event-style.

var WatchIO = require('watch.io'),
    watcher = new WatchIO()
;

// Watch a folder recursively
watcher.watch('/path/to/folder');

// Listen on file creation
watcher.on('create', function ( file, stat ) {
    // expect( file ).to.be.a('string');
    // expect( stat ).to.be.a( fs.Stats );
});

// Listen on file updating
watcher.on('update', function ( file, stat ) {
    // expect( file ).to.be.a('string');
    // expect( stat ).to.be.a( fs.Stats );
});

// Listen on file removal
watcher.on('remove', function ( file, stat ) {
    // expect( file ).to.be.a('string');
    // expect( stat ).to.be.a( fs.Stats );
});

// Listen on file refreshment
// The `refresh` event emits when the WatchIO scans a folder
// which usually occur by calling the `.watch(path)` function
watcher.on('refresh', function ( file, stat ) {
    // expect( file ).to.be.a('string');
    // expect( stat ).to.be.a( fs.Stats );
});

// Listen on whatever the file changes
// the `type` parameter can be any one of: 'create', 'update', 'remove', 'refresh'
watcher.on('change', function ( type, file, stat ) {
    // expect( type ).to.be.a('string');
    // expect( file ).to.be.a('string');
    // expect( stat ).to.be.a( fs.Stats );
});

// Listen on whatever the fs.FSWatcher throws an error
// the `err` parameter is the same as the one from 'error' event of fs.FSWatcher
watcher.on('error', function ( err, file ) {
    // expect( err ).to.be.an( Error );
    // expect( file ).to.be.a('string');
});

// Stop watching the folder/file
watcher.close('/path/to/folder');

Removing event listeners is the same as the way in events.EventEmitter of node.js.

// As:
watcher.removeAllListeners('create');
watcher.removeAllListeners('update');
watcher.removeAllListeners('remove');
watcher.removeAllListeners('refresh');
watcher.removeAllListeners('change');
watcher.removeAllListeners('error');
// Or:
watcher.removeAllListeners();

Options

Initialize WatchIO object with config:

var WatchIO = require('watch.io'),
    watcher = new WatchIO({
        delay: 100
    })
;

Options:

  • delay number Delay time(ms) for suppress duplicated notify messages from fs.watch(), defaults to 100(ms), set to 0 to disable it.

Windows-platform Issues

Due to the behavior of the underlying API, there have some issues still suck on Windows platform.

  • Removing folders will emit an 'EPERM' error. No solutions so far.

  • Creating folders manually on Windows, sometimes emit an uncaught 'EBUSY' error. This can be fixed by setting a delay milliseconds longer than 100ms in the Watch.IO options.

We strongly recommend to use the Watch.IO in the Linux platform or other UNIX-like things. Or you can try chokidar or watch

License

The MIT License (MIT)

Copyright (c) 2009-2016, DJ-NotYet dj.notyet@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial