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 with npm:
$ npm install --save reposSee the changelog for updates.
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.
| 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 |
$ repos <names> <dest>names- one or more comma-separated user names or orgsdest- destination path to use, default isrepos.json
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 testBuilding 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 && verbYou might also be interested in these projects:
- gists: Methods for working with the GitHub Gist API. Node.js/JavaScript | homepage
- github-base: Low-level methods for working with the GitHub API in node.js/JavaScript. | homepage
- github-content: Easily download files from github raw user content. | homepage
- github-contributors: Generate a markdown or JSON list of contributors for a project using the GitHub API. | homepage
- topics: Get and update GitHub repository topics. | homepage
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on August 19, 2018.