UNPKG

3.33 kBMarkdownView Raw
1# get-pkgs [![NPM version](https://img.shields.io/npm/v/get-pkgs.svg?style=flat)](https://www.npmjs.com/package/get-pkgs) [![NPM monthly downloads](https://img.shields.io/npm/dm/get-pkgs.svg?style=flat)](https://npmjs.org/package/get-pkgs) [![NPM total downloads](https://img.shields.io/npm/dt/get-pkgs.svg?style=flat)](https://npmjs.org/package/get-pkgs) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/get-pkgs.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/get-pkgs)
2
3> Get the package.json for an array of repos from the npm registry, optionally filtering properties using glob patterns.
4
5Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
6
7## Install
8
9Install with [npm](https://www.npmjs.com/):
10
11```sh
12$ npm install --save get-pkgs
13```
14
15## Usage
16
17```js
18const getPkgs = require('get-pkgs');
19
20// takes a callback
21getPkgs(['assemble', 'verb'], function(err, pkgs) {
22 console.log(pkgs);
23});
24
25// or returns a promise
26getPkgs(['assemble', 'verb'])
27 .then(pkgs => console.log(pkgs))
28 .catch(console.error);
29```
30
31## About
32
33<details>
34<summary><strong>Contributing</strong></summary>
35
36Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
37
38</details>
39
40<details>
41<summary><strong>Running Tests</strong></summary>
42
43Running 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:
44
45```sh
46$ npm install && npm test
47```
48
49</details>
50
51<details>
52<summary><strong>Building docs</strong></summary>
53
54_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
55
56To generate the readme, run the following command:
57
58```sh
59$ npm install -g verbose/verb#dev verb-generate-readme && verb
60```
61
62</details>
63
64### Related projects
65
66You might also be interested in these projects:
67
68* [get-first-commit](https://www.npmjs.com/package/get-first-commit): Returns a git repository's first commit as a JavaScript object. | [homepage](https://github.com/jonschlinkert/get-first-commit "Returns a git repository's first commit as a JavaScript object.")
69* [get-pkg](https://www.npmjs.com/package/get-pkg): Get the package.json for a project from npm. | [homepage](https://github.com/jonschlinkert/get-pkg "Get the package.json for a project from npm.")
70* [github-base](https://www.npmjs.com/package/github-base): JavaScript wrapper that greatly simplifies working with GitHub's API. | [homepage](https://github.com/jonschlinkert/github-base "JavaScript wrapper that greatly simplifies working with GitHub's API.")
71
72### Author
73
74**Jon Schlinkert**
75
76* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
77* [GitHub Profile](https://github.com/jonschlinkert)
78* [Twitter Profile](https://twitter.com/jonschlinkert)
79
80### License
81
82Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
83Released under the [MIT License](LICENSE).
84
85***
86
87_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 28, 2018._
\No newline at end of file