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-03-20 00:25:40 +08:00
|
|
|
## 2.0.0
|
2014-02-17 12:43:16 +08:00
|
|
|
|
2014-03-20 00:25:40 +08:00
|
|
|
Breaking changes in `2.0.0`:
|
2014-02-17 12:43:16 +08:00
|
|
|
|
|
|
|
|
The second argument is now an `Object` that contains the following keys:
|
|
|
|
|
|
|
|
|
|
* `depth` optional, defaults to Infinity
|
|
|
|
|
* `log` optional log Function
|
2014-03-20 00:25:40 +08:00
|
|
|
* `dev` optional, default false, set to true to include devDependencies
|
2014-02-17 12:43:16 +08:00
|
|
|
|
2012-06-16 01:00:30 +08:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
|
var readInstalled = require("read-installed")
|
2014-03-20 00:25:40 +08:00
|
|
|
// optional options
|
|
|
|
|
var options = { dev: false, log: fn, depth: 2 }
|
|
|
|
|
readInstalled(folder, options, function (er, data) {
|
2012-06-16 01:00:30 +08:00
|
|
|
...
|
|
|
|
|
})
|
|
|
|
|
```
|
