'on' event callback signature

[alexyoung]

Your example reads like this:

watcher.watch("C:\\myDir", function(err, watcher) {
    if(err) {
        console.log("ERROR: " + err);
    } else {
        console.log("DONE");
    }
});

When I try that (in Mac OS X) the callback doesn't follow the same signature. Whenever any change happens (file creation, deletion, change) the err value is a string set to rename, and the second parameter is the directory name, then the third parameter is the object for a Watcher.

This is the code I tried it with:

var treeWatcher = require('tree-watcher')
  , watcher;

watcher = new treeWatcher.Watcher({
  filter: function(filename) {
    return filename.charAt(0) !== '.';
  }
, throttle: 50
});

watcher.on('change', function(err, w) {
  console.log('change args:', arguments);
  if (err) {
    console.error('Error:', err);
  } else {
    console.log('Watcher state:', w);
  }
});

watcher.watch('/Users/alex/Desktop/watch', function() {
  console.log('Args:', arguments);
});

[ddeschepper]

The callback you give to the watcher.watch(dir, callback) method executes only once: when the watch method is finished (that is: when it is done attaching all the handlers). It gets two arguments: an error (or null if no error happened, just like in most of the Node File System module methods) and the Watcher object.

The callback for change events is attached using watcher.on("change", callback) and gets three arguments: the event that happened (according to the FSWatcher that is watching the directory, the full path to the file/directory that caused the event and the Watcher object.

I agree this is not completely clear from the readme I made and I will change it to explain the use of this module better. I'm also working on a version that does better error handling on access problems and that handles renaming directories better.

[alexyoung]

I think I meant to paste the watcher.on part rather than watcher.watch, the arguments my callbacks receive for the on event seem to be wrong (it always says rename).