Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

A user from the GitHub API. See IUserResponse for .raw fields.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new User(username: string, token: string): User

  • Creates an instance of User.

    memberof

    User

    Parameters

    • username: string

      The username to get information for.

    • token: string

      The token to authenticate on

    Returns User

Properties

avatarUrl

avatarUrl: string

bio

bio: string

blog

blog: string

company

company: string

createdAt

createdAt: string

email

email: string

Private eventsUrl

eventsUrl: string

followers

followers: number

Private followersUrl

followersUrl: string

following

following: number

Private followingUrl

followingUrl: string

Private gistsUrl

gistsUrl: string

gravatarId

gravatarId: string

hireable

hireable: boolean

htmlUrl

htmlUrl: string

id

id: number

location

location: string

login

login: string

name

name: string

nodeId

nodeId: string

Private organizationsUrl

organizationsUrl: string

publicGists

publicGists: number

publicRepos

publicRepos: number

raw

raw: IUserResponse

Private receivedEventsUrl

receivedEventsUrl: string

Private reposUrl

reposUrl: string

siteAdmin

siteAdmin: boolean

Private starredUrl

starredUrl: string

Private subscriptionsUrl

subscriptionsUrl: string

type

type: string

updatedAt

updatedAt: string

url

url: string

Methods

endpoint

  • endpoint(path: string): Promise<any>

getFollowers

  • getFollowers(): Promise<object>