poller

0.0.5 • Public • Published

Poller

NPM version Build Status Dependency Status devDependency Status Coverage Status Code Climate Codacy Badge

A FileSystem poller for Node.js

Summary

This was developed as a reliable alternative to using file watching libraries like Chokidar and Node Watch.

Install

npm install poller

Usage

// Require the library
const poller = require('poller');
 
// Poll a file directory
poller('/tmp/myFolder', (err, poll) => {
 
    // Log every time a file is added into the folder
    poll.on('add', (filePath) => {
        console.log(filePath,'was added');
    });
 
    // Log every time a file is removed from the folder
    poll.on('remove', (filePath) => {
        console.log(filePath,'was removed');
    });
 
    // Stop polling the folder for file adds/removals
    poll.close();
 
});
 
// Poll a file directory at an interval of 50ms (the default is 100ms)
poller('/tmp/myFolder', {interval: 50}, (err, poll) => {
 
});

Licence and Rights

© 2016 Anephenix Ltd. Poller is licenced under the MIT license. - See LICENSE for details.

Readme

Keywords

Package Sidebar

Install

npm i poller

Weekly Downloads

72

Version

0.0.5

License

MIT

Last publish

Collaborators

  • paulbjensen