package-dependency-stats
Gets the npm reigstry stats for all the dependencies in a package.json
object. Also see gh-repo-dependencies.
Install
npm install package-dependency-stats --save
Example
var packageStats = var readPackage =
Usage
packageDepStats(packageJson, [opt], [cb])
Fetches npm registry stats from the dependencies in packageJson
(an object).
Options:
filter
(Function) optionally filter the dependencies before querying npm registry
For example, filter
could look like this to avoid querying registry stats of devDependencies.
{ return packagelist === 'dependencies'}
The callback takes the form (err, data)
, where data
is a flat array of dependencies gleaned from dependencies
, devDependencies
, peerDependencies
, optionalDependencies
(in that order) unless otherwise filtered.
Each item has the following data:
name: 'inherits' // name as it appears in package.json version: '^2.0.1' // version range from package.json list: 'dependencies' // type of dependency stats: ... // registry stats error: Error // Error object if there was a problem
If stats
could not be retrieved for that package, it will be null and error
will be populated with the Error object. Otherwise error
will not be defined.
The stats are fetched using npm-stats.
Note: packageJson
can be a simple object like so:
See Also
- gh-repo-dependencies - same as this tool, but gleaned from a GitHub repository
- repo-deps - CLI tool with similar goals
- read-closest-package - get a package.json from cwd
License
MIT, see LICENSE.md for details.