summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/read-installed/README.md
blob: 312153b4fe9ef28394192c734307887abe3fbdca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# 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) {
  ...
})
```