Github.getUserDetails()

Get the GitHub profile data for a user.

Usage

Hover over inputs/exits for more info.

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


// Get the GitHub profile data for a user.

Github.getUserDetails({

user: 'mikermcneil',

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// OK.

success: function (result) {

 

},

});

Inputs

user required

The user or organization to look up (i.e. as it appears in the URL on GitHub)

'mikermcneil'

Exits

error

An unexpected error occurred.

success

OK.

{ username: 'mikermcneil',
  isOrganization: false,
  name: 'Mike McNeil',
  email: 'customers@balderdash.co',
  avatarUrl: 'https://avatars.githubusercontent.com/u/618009?v=3',
  blogUrl: 'http://balderdash.co',
  githubProfileUrl: 'https://github.com/mikermcneil',
  location: 'Austin, TX',
  company: 'Balderdash',
  bio: '',
  numFollowers: 437,
  numPublicRepos: 82,
  numPublicGists: 122,
  isHireable: true }