top-dependents v1.1.0

top-dependents

Fetches the top dependents for the given NPM module

Install

npm install --save top-dependents

API

var topDeps = require('top-dependents');
// returns an Api object

The module's api has the following promise-returning methods

topDependents(packageName, maxNumber)

topDeps.topDependents(name, n)
  .then(function (list) {
    // list is Array of strings - names of dependent modules
  });
/*
  example: topDeps.topDependents('heroin', 10)
    returns ['opiate', 'qunit-inject']
*/

infoForDependents(metric, listOfNames)

Fetches given metric for a list of package names. Available metrics are "downloads" and "starred".

topDeps.infoForDependents(metric, listOfNames)
  .then(function (results) {
    // results { dependentA: X, dependentB: Y }
    // where X, Y are metrics
  });

sortedByValue(object)

Takes an object where all values are numbers and returns list of properties corresponding to the values sorted in descending order. Provided for convenience.

var what = {
  a: 100,
  b: 20,
  c: 50
};
var sorted = topDeps.sortedByValue(what);
// sorted is ['a', 'c', 'b']

Small print

Author: Gleb Bahmutov © 2015

• @bahmutov
• glebbahmutov.com
• blog

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2015 Gleb Bahmutov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.