Nuptial Predicament Mediation
Introducing npm Teams! Private packages + team management tools.Learn more »

repos

2.0.0 • Public • Published

repos NPM version NPM monthly downloads NPM total downloads

Tiny wrapper around github-base for getting publicly available information for a repository, or all of the repositories for one or more users or orgs, from the GitHub API.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save repos

Release history

See the changelog for updates.

Usage

This library is a tiny wrapper around github-base, see that project's readme for more information about available options and authentication choices.

Params

  • users {String|Array}: One or more users or organization names.
  • options {Object}: See available options.
  • returns {Promise}

Example

const repos = require('repos');
const options = {
  // see github-base for other authentication options
  token: 'YOUR_GITHUB_AUTH_TOKEN'
};
repos(['doowb', 'jonschlinkert'], options)
  .then(function(repos) {
    // array of repository objects
    console.log(repos);
  })
  .catch(console.error)

See the GitHub API documentation for repositories for more details about the objects returned for each repository.

Options

Option Type Default Description
filterOrgs function undefined Function for filtering organizations from the result.
filterRepos function undefined Function for filtering repositories from the result.
sort boolean true By default, the returned list is sorted by repository name

CLI

$ repos <names> <dest>
  • names - one or more comma-separated user names or orgs
  • dest - destination path to use, default is repos.json

About

Contributing

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

Running Tests

Running 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:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on August 19, 2018.

Install

npm i repos

DownloadsWeekly Downloads

18

Version

2.0.0

License

MIT

Unpacked Size

11.7 kB

Total Files

6

Last publish

Collaborators

  • avatar
  • avatar