summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/fstream-npm/README.md
blob: 2c01e90731872217b1170677d88fc54ef86b2ba1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# fstream-npm

This is an fstream DirReader class that will read a directory and filter
things according to the semantics of what goes in an npm package.

For example:

```javascript
// This will print out all the files that would be included
// by 'npm publish' or 'npm install' of this directory.

var FN = require("fstream-npm")
FN({ path: "./" })
  .on("child", function (e) {
    console.error(e.path.substr(e.root.path.length + 1))
  })
```