pkg-cache

Gets the package.json for one or more names from the npm registry and caches the results for a specified period of time. Default cache period is one week.

Install

Install with npm:

$ npm install pkg-cache --save

Usage

var pkgCache = require('pkg-cache');

API

pkgCache

Get the package.json for one or more names. Results are cached for 1 week by default.

Params

• names {String|Array}: package names
• options {Object}
• callback {Function}
• returns {Array}: Returns an array of package.json objects.

Example

// results are cached for 1 week by default
pkgCache(['micromatch', 'base'], function(err, pkgs) {
  if (err) throw err;
  console.log(pkgs);
});

// customize the cache "max age"
pkgCache(['micromatch', 'base'], {timespan: '1 week ago'}, function(err, pkgs) {
  if (err) throw err;
  console.log(pkgs);
});

// or
pkgCache(['micromatch', 'base'], {maxAge: '0 sec'}, function(err, pkgs) {
  if (err) throw err;
  console.log(pkgs);
});

Related projects

You might also be interested in these projects:

• data-store: Easily get, set and persist config data. | homepage
• date-store: Easily persist or get stored dates/times. Useful for conditionally making updates in an application based… more | homepage
• get-pkg: Get the package.json for a project from npm. | homepage
• get-pkgs: Get the package.json for an array of repos from the npm registry, optionally filtering properties… more | homepage

Contributing

This document was generated by verb, please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

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

Building docs

Generate readme and API documentation with verb:

$ npm install -g verb verb-readme-generator && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on June 03, 2016.