Github.listRepos()

Fetch the list of repos belonging to the specified Github user or organization.

Usage

Hover over inputs/exits for more info.

var Github = require('machinepack-github');


// Fetch the list of repos belonging to the specified Github user or organization.

Github.listRepos({

owner: 'balderdashy',

limit: 30,

skip: 0,

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// OK.

success: function (repos) {

 

},

});

Inputs

owner required

The name of the user or organization (i.e. as it appears in the URL on GitHub)

'balderdashy'
limit

Maximum number of repos to retrieve (for pagination)

30
skip

Index of the first repo to retrieve, starting from 0 (for pagination)

0

Exits

error

An unexpected error occurred.

success

OK.

[ { id: 1296269,
    owner: 
     { login: 'octocat',
       id: 1,
       avatar_url: 'https://github.com/images/error/octocat_happy.gif',
       gravatar_id: 'somehexcode',
       url: 'https://api.github.com/users/octocat',
       html_url: 'https://github.com/octocat',
       followers_url: 'https://api.github.com/users/octocat/followers',
       following_url: 'https://api.github.com/users/octocat/following{/other_user}',
       gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
       starred_url: 'https://api.github.com/users/octocat/starred{/owner}{/repo}',
       subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
       organizations_url: 'https://api.github.com/users/octocat/orgs',
       repos_url: 'https://api.github.com/users/octocat/repos',
       events_url: 'https://api.github.com/users/octocat/events{/privacy}',
       received_events_url: 'https://api.github.com/users/octocat/received_events',
       type: 'User',
       site_admin: false },
    name: 'Hello-World',
    full_name: 'octocat/Hello-World',
    description: 'This your first repo!',
    private: false,
    fork: false,
    url: 'https://api.github.com/repos/octocat/Hello-World',
    html_url: 'https://github.com/octocat/Hello-World',
    clone_url: 'https://github.com/octocat/Hello-World.git',
    git_url: 'git://github.com/octocat/Hello-World.git',
    ssh_url: 'git@github.com:octocat/Hello-World.git',
    svn_url: 'https://svn.github.com/octocat/Hello-World',
    mirror_url: 'git://git.example.com/octocat/Hello-World',
    homepage: 'https://github.com',
    forks_count: 9,
    stargazers_count: 80,
    watchers_count: 80,
    size: 108,
    default_branch: 'master',
    open_issues_count: 0,
    has_issues: true,
    has_wiki: true,
    has_downloads: true,
    pushed_at: '2011-01-26T19:06:43Z',
    created_at: '2011-01-26T19:01:12Z',
    updated_at: '2011-01-26T19:14:43Z',
    permissions: { admin: false, push: false, pull: true } } ]