github-owner-repos
v0.1.0
Published
Get the github repositories for the specified owner or array of owners.
Downloads
7
Readme
github-owner-repos
Get the github repositories for the specified owner or array of owners.
Install
Install with npm:
$ npm install --save github-owner-repos
Usage
var ownerRepos = require('github-owner-repos');
API
ownerRepos
Get all of the repositories for the specified owner or array of owners. Owners may be users or organizations. The result is an object where each key is an owner name and each value is an array of repositories for that owner.
Specify a filter
function on the options to reduce the number of repositories return.
Specify a username
and password
combo or a token
to be used for authenticating to github
to increase the rate limit on the api. See github-base documentation for more information.
Params
owners
{String|Array}: Single or multiple owners.options
{Object}: Additional options passed to github-base and used for filter.options.filter
{Function}: Optional filter function used to filter out returned repos.cb
{Function}: Optional callback function that will receive anerr
andresult
parameter. A promise is returned when the callback function is not provided.returns
{Promise}: When a callback function is not provided, a promise is returned
Example
var options = {
// only return "source" repositories
// these are when repo.fork === false
filter: function(repo) {
return !repo.fork;
}
};
ownerRepos('doowb', options, function(err, result) {
if (err) return console.error(err);
console.log(result);
//=> {
//=> doowb: [
//=> { name: ... },
//=> { name: ... },
//=> { name: ... }
//=> ]
//=> }
});
About
Related projects
github-base: Base methods for creating node.js apps that work with the GitHub API. | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for avice on opening issues, pull requests, and coding standards.
Building docs
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Brian Woodward
License
Copyright © 2016, Brian Woodward. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.30, on August 31, 2016.