Module-dependents NPM

module-dependents

Get the list of npm modules that depend on any other npm module.

Install

Install with npm:

$ npm install --save module-dependents

Install with yarn:

$ yarn add module-dependents

Usage

var moduleDependents = require('module-dependents');

API

moduleDependents

Get the list of npm modules that depend on any other npm module.

Params

name {String}: Name of module to retrieve dependents for.
options {Object}: Options to pass along to npm-api-dependents
options.raw {Function}: Optionally specify to get a raw object with a name property for each dependent.
returns {Stream}: Returns an object stream with each object being an instance of Repo from the npm-api module.

Example

// returns a stream
moduleDependents('micromatch')
  .on('data', function(dependent) {
    console.log(dependent.name);
  });

About

Related projects

npm-api-dependents: npm-api plugin for getting module dependents. | homepage
npm-api: Base class for retrieving data from the npm registry. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: