node/deps/npm/node_modules/read-installed/README.md

26 lines
521 B
Markdown
Raw Normal View History

2012-06-16 01:00:30 +08:00
# read-installed
Read all the installed packages in a folder, and return a tree
structure with all the data.
npm uses this.
2014-02-17 12:43:16 +08:00
## 1.0.0
Breaking changes in `1.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, dev=true to mark devDeps as extraneous
2012-06-16 01:00:30 +08:00
## Usage
```javascript
var readInstalled = require("read-installed")
2014-02-17 12:43:16 +08:00
readInstalled(folder, { depth, log, dev }, function (er, data) {
2012-06-16 01:00:30 +08:00
...
})
```