README

Get Packages

Fetch the information for packages inside the npm registry

Install

NPM

Install: npm install --save getpackages
Module: require('getpackages')

Editions

This package is published with the following editions:

getpackages aliases getpackages/index.js which uses Editions to automatically select the correct edition for the consumers environment
getpackages/source/index.coffee is Source + CoffeeScript + Require
getpackages/esnext/index.js is CoffeeScript Compiled + ESNext + Require
getpackages/es2015/index.js is CoffeeScript Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

// Create our instance
var getter = require('getpackages').create({
    onlyLatest: true,           // optional (defaults to `true`), accepts a boolean, `true` will fetch information only for the latest version, `false` wil fetch information for all versions
    log: console.log           // optional (defaults to `null`), accepts a function that accepts the arguments: level, message... 
});

// Fetch the data on these github repositories
getter.fetchPackagesByNames(['bevry/getpackages'], function(err, entries){
    console.log(err, entries);

    // Fetch all the repo data on these github users/organisations
    getter.fetchPackagesByKeyword('docpad-plugin', function(err, entries){
        console.log(err, entries);

        // Get the combined listing
        console.log(getter.getEntries());
    });
});