npm-api-dependents     

> npm-api plugin for getting module dependents.

Install

Install with npm:

``sh
$ npm install --save npm-api-dependents
`

Install with yarn:

`sh
$ yarn add npm-api-dependents
`

Usage

`js
var npm = require('npm-api')();
var dependents = require('npm-api-dependents');
npm.use(dependents());

var repo = npm.repo('micromatch');

// returns a readable stream
repo.dependents()
.on('data', function(repo) {
console.log(repo);
});
`

API

$3

Get the dependents for the current repo.

Params

* options {Object}: Options to handle returned results
* options.raw {Boolean}: Optional. Set to true to receive objects of the form { name: 'module' } instead of Repo objects.
* returns {Stream}: Returns a readable stream (object mode).

Example

`js
var repo = npm.repo('micromatch');

// returns a readable stream
repo.dependents()
.on('data', function(repo) {
console.log(repo);
});
`

About

$3

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

$3

| Commits | Contributor |
| --- | --- |
| 6 | doowb |
| 1 | ralphtheninja |

$3

_(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:

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

$3

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:

`sh
$ npm install && npm test
``

$3

Brian Woodward

* github/doowb
* twitter/doowb

$3

Copyright © 2017, Brian Woodward.
Released under the MIT License.

*

_This file was generated by verb-generate-readme, v0.6.0, on December 27, 2017._