getpackages

2.0.0 • Public • Published

Get Packages

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

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

    Contribute

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    History

    Discover the release history by heading on over to the HISTORY.md file.

    Backers

    Maintainers

    These amazing people are maintaining this project:

    Sponsors

    No sponsors yet! Will you be the first?

    Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    License

    Unless stated otherwise all works are:

    and licensed under:

    Package Sidebar

    Install

    npm i getpackages

    Weekly Downloads

    0

    Version

    2.0.0

    License

    MIT

    Last publish

    Collaborators

    • bevryme