Class: GithubUser

githubAdapter GithubUser

Class representing minimal Github API wrapper for user interaction.


new GithubUser()

Properties:
Name Type Description
github

Instance of GitHubApi (TODO: add link)

Methods


<async> get(token)

Get Github user data.

This method is augumented by module:docloop#cache(2000) return value will be cached for 2 seconds in order to prevent huge numbers of API calls.

Parameters:
Name Type Description
token String

Github user access token

Throws:

If token is not a string.

Type
TypeError
Returns:

Github user data

Type
Object

<async> getInstallations(token)

Get data for all installations granted access to by provided access token.

This method is augumented by module:docloop#cache(2000) return value will be cached for 2 seconds in order to prevent huge numbers of API calls.

Parameters:
Name Type Description
token String

Github user access token

Returns:

Installation id of each accessible installation

Type
Array.<Object>