var repos = require( '@stdlib/_tools/github/user-repos' );

Gets meta data for repositories associated with a user.

var opts = {
    'username': 'kgryte'
};

repos( opts, clbk );

function clbk( error, results, info ) {
    // Check for rate limit information...
    if ( info ) {
        console.error( 'Limit: %d', info.limit );
        console.error( 'Remaining: %d', info.remaining );
        console.error( 'Reset: %s', (new Date( info.reset*1000 )).toISOString() );
    }
    if ( error ) {
        throw new Error( error.message );
    }
    console.log( JSON.stringify( results ) );
    // => <repo_data>
}

The function accepts the following options:

• token: GitHub access token.
• username: GitHub username.
• type: repository type. Can be one of all, owner, member, public, or private. The public and private options are only applicable if the function is provided a token and no username.
• sort: method used to sort meta data. Can be one of full_name, created, pushed, or updated.
• direction: sort direction; either asc or desc.
• visibility: repository visibility. Can be one of all, public, or private. Applicable if provided a token and no username. Ignored if type option is present.
• affiliation: repository affiliation. A comma-separated list of values, which may include: owner, collaborator, organization_member. Applicable if provided a token and no username. Ignored if type option is present.
• useragent: user agent string.

To authenticate with GitHub, set the token option.

var opts = {
    'token': 'tkjorjk34ek3nj4!'
};

repos( opts, clbk );

To specify a user agent, set the useragent option.

var opts = {
    'username': 'kgryte',
    'useragent': 'hello-github!'
};

repos( opts, clbk );

To return repositories of a particular type, set the type option.

var opts = {
    'username': 'kgryte',
    'type': 'owner'
};

repos( opts, clbk );

To return repositories of a particular visibility, set the visibility option.

var opts = {
    'token': 'tkjorjk34ek3nj4!',
    'visibility': 'private'
};

repos( opts, clbk );

To return repositories of a particular affiliation, set the affiliation option.

var opts = {
    'token': 'tkjorjk34ek3nj4!',
    'affiliation': 'collaborator,organization_member'
};

repos( opts, clbk );

Creates a reusable function.

var opts = {
    'username': 'kgryte',
    'token': 'tkjorjk34ek3nj4!'
};

var get = repos.factory( opts, clbk );

get();
get();
get();
// ...

The factory method accepts the same options as repos().

• Either a username or a token or both must be provided. If provided a token, but not a username, the function fetches repositories associated with the authenticated user.

• If not provided a token, the function can only return public repository meta data.

• Rate limit information includes the following:

  • limit: maximum number of requests a consumer is permitted to make per hour.
  • remaining: number of remaining requests.
  • reset: time at which the current rate limit window resets in UTC seconds.