fwatcher

Watch files for changes.

:cloud: Installation

# Using npm
npm install --save fwatcher

# Using yarn
yarn add fwatcher

:clipboard: Example

// Dependencies
var FileWatcher = require("fwatcher")
  , Logger = require("bug-killer")
  ;

// Listen for changes for 5 seconds
var watcher = FileWatcher(__dirname + "/test.txt", function (err, ev, path) {
    if (err) { return Logger.log(err, "error"); }
    Logger.log([ev, path].join(" "));
});
setTimeout(watcher.off.bind(watcher), 5000);


// Listen only for one change
FileWatcher(__dirname + "/once.txt", true, function (err, ev, path) {
    if (err) { return Logger.log(err, "error"); }
    Logger.log([ev, path].join(" "));
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

Watcher(path, handler)

Creates a new instance of the internal Watcher.

Params

• String path: The path to the file.
• Function handler: A function called when the file changes.

off()

Removes the listener.

FileWatcher(path, options, callback)

Creates a new file watcher.

Params

• String path: The path to the file.

• Boolean|Options options: A boolean value representing the once value or an object containing the following fields:

• once (Boolean): If true, the handler is deleted after first event.

• Function callback: This function will be called when the file is changed or renamed. The first parameter is the error, the second one is the evenit name and the third one is the file path.

Return

• Watcher The watcher instance.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• element-status (by CallahanRTS)—An electron based status bar
• rucksack (by Bloggify)—JavaScript and CSS bundler.
• web-term—A full screen terminal in your browser.

:scroll: License

MIT © Ionică Bizău