npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

file-watcher

v0.0.2

Published

Modern file watcher for nodejs

Downloads

7

Readme

file-watcher

Modern file watcher for nodejs

  • Watch a directory and his subdirectories for changes
  • Filter method to exclude files or directories

Installation

npm install file-watcher

Usage


var Watcher = require('file-watcher');

var watcher = new Watcher({
    root: __dirname,
    filter: function(filename, stats) {
        // only watch those files
        if(filename.indexOf('.styl') != -1) {
            return true;
        }
        else {
            return false;
        }
    }
});

watcher.on('...', function() { /* Watcher is an EventEmitter */ });

watcher.watch();

constructor new Watcher(opts)

  • opts.root : Directory to watch
  • opts.filter : callback to filter filename or by fs.Stat

callback filter(filename, stats)

  • filename : filename relative to the root of the watched tree
  • stats : a fs.Stat object

Return true to include this file or directory and their children. Return false to exclude them.

method watcher.watch()

Start watching the directory tree

event create (event)

  • event.oldStats : null
  • event.oldPath : null
  • event.newStats : a fs.Stat object
  • event.newPath : created filename relative to the root of the watched tree

event change (event)

  • event.oldStats : last fs.Stat object
  • event.oldPath : current filename relative to the root of the watched tree
  • event.newStats : current fs.Stat object
  • event.newPath : current filename relative to the root of the watched tree

event delete (event)

  • event.oldStats : last fs.Stat object
  • event.oldPath : deleted filename relative to the root of the watched tree
  • event.newStats : null
  • event.newPath : null

event any (type, event)

  • type : event type
  • event : see corresponding event type

event error (err)

  • err : unhandled error

TODOs

  • Add unit tests
  • Handle rename
  • ?

History

  • 2013-06-11 : first working version