node/deps/npm/node_modules/read-installed/README.md
isaacs bd547d6598 npm: upgrade to 1.4.6
* Documentation upgrades
* Fix glob bug which prevents proper README publishing
* node-gyp upgrade to 0.13
* Documentation updates
* Add --save-exact to save an exact dep (instead of a range)
* alias 't' to 'test'
2014-03-25 17:42:22 -07:00

28 lines
592 B
Markdown

# read-installed
Read all the installed packages in a folder, and return a tree
structure with all the data.
npm uses this.
## 2.0.0
Breaking changes in `2.0.0`:
The second argument is now an `Object` that contains the following keys:
* `depth` optional, defaults to Infinity
* `log` optional log Function
* `dev` optional, default false, set to true to include devDependencies
## Usage
```javascript
var readInstalled = require("read-installed")
// optional options
var options = { dev: false, log: fn, depth: 2 }
readInstalled(folder, options, function (er, data) {
...
})
```