doowb / npm-api-dependents

npm-api plugin for streaming an npm module's dependents information

npm-api-dependents

npm-api plugin for getting module dependents.

Install

Install with npm:

$ npm install --save npm-api-dependents

Install with yarn:

$ yarn add npm-api-dependents

Usage

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

.dependents

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

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

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

About

Contributing

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

Contributors

Commits	Contributor
6	doowb
1	ralphtheninja

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:

$ npm install && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

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

---

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

npm-api-dependents's Issues

add tests

No longer works?

Trying to run this example from the docs:

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);
  });

Gives me this:

TypeError: Class constructor NpmApi cannot be invoked without 'new'

Node 8.9.3 and 12.4.0.

Refactor `dependents` method

I'd like to refactor this library, which is mainly the main dependents method, so it's easier to use downstream as a streaming module instead of batching reads.

• Remove generator syntax and use promises directly when necessary
• use view.stream instead of view.query
• options.mapFn won't be necessary. Since this is an npm-api plugin, values can be transformed directly into Repo objects using app.repo(name) then pushed onto the stream.
• options.raw consider adding options.raw to push data directly through the stream without initializing new Repo instances.

update travis