var path = require ('path');
var surveil = require ('surveil');
 
var subjectDir = surveil (
  "super/secret/files/",
  { // options argument is optional - defaults shown
    /*
      `change` events closer together than
      this are grouped into one. Implies a
      minimum latency to `change` events
      being fired. (in milliseconds)
    */
    changeTimeout:    150,
    /*
      Number of times to retry establishing
      a file watch when receiving the
      `EPERM` event from the filesystem.
    */
    epermRetries:     5,
    /*
      Proper support for missing path
      features hasn't landed yet. For now a
      simple poll timeout is used to test
      the surveil'd path. (in milliseconds)
    */
    hack_missingPoll: 1000,
    /*
      Only accept files with names ending
      in one of the provided extensions.
      If the period is required you must
      specify it. Directories are not
      affected by filename filters.
      Default: undefined
    */
    extensions:       [
      ".jpg",
      ".jpeg",
      ".png",
      ".gif"
    ],
    /*
      Only accept files with names
      matching at least one of the
      provided regular expressions. Does
      not apply when `extensions` is set.
      Directories are not affected by
      filename filters.
      Default: undefined
    */
    patterns:         [
      /report/,
      /sallary/,
      /\.xls$/
    ],
    /*
      EXPERIMENTAL FEATURE (NO TESTS)
      Watches a directory recursively
      and emits normal events with local
      paths.
    */
    recursive:        true
  }
);
 
subjectDir.on ('ready', function (err) {
  // if present, the `err` argument will also
  // trigger an `error` event
});
 
subjectDir.on ('child', function (filename, stats) {
  // shares the `stat` call used to discover files
  // filename must match any filters present
  // only emitted before the "ready" event has fired
});
 
subjectDir.on ('childDir', function (dirname, stats) {
  // shares the `stat` call used to discover directories
  // dirname may not match any filters present
  // only emitted before the "ready" event has fired
});
 
subjectDir.on ('add', function (filename, stats) {
  // a new file has been added and the initial
  // content write operation appears to have
  // concluded.
  // if no arguments are passed, the watched path
  // was missing and has appeared.
  // If filename filters are present, filename will
  // conform to them.
});
 
subjectDir.on ('addDir', function (dirname, stats) {
  // a new subdirectory has appeared
  // it may not conform to any filename filters present
});
 
subjectDir.on ('remove', function (filename) {
  // a file has been removed.
  // If no filename argument is passed, the watched
  // path has disappeared.
});
 
subjectDir.on ('change', function (filename) {
  // a file change event or rapid group of
  // such events has just occured.
  // no new stat call is made, therefor none is shared.
  // If the watched path is a file, no filename
  // argument is passed.
});