Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UserProfile

Public profile of GitHub user

Hierarchy

  • UserProfile

Index

Properties

avatarUrl

avatarUrl: string

The URL pointing to the profile's avatar (image) on GitHub – e.g. 'https://avatars0.githubusercontent.com/u/1024025?s=460&v=4'

company

company: string

Name of company that the user works for. Can be annoted as '@' (mentioning name of the company's organization on GitHub) or '' (just plain text).

creationDateTime

creationDateTime: Date

When the profile was created on GitHub

displayName

displayName: string

Name of the public profile (most often the real name of the person)

followersCount

followersCount: number

Number of users following this profile

forHire

forHire: boolean

Indicates if the user is available for hire

gitHubId

gitHubId: string

GitHub's own id for user

publicUrl

publicUrl: string

The URL pointing to the profile on GitHub – e.g. 'https://github.com/torvalds'

username

username: string

Username of user

Generated using TypeDoc