Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserRoute

Hierarchy

  • Routefetcher
    • UserRoute

Index

Methods

getCommitContributionsInMonth

getCommitContributionsInYear

  • getCommitContributionsInYear(username: string, inYear: number): Promise<MonthlyContributions[] | null>

getContributionYears

  • getContributionYears(username: string): Promise<number[] | null>
  • Returns all years in which the user has contributed code in repositories on GitHub – e.g. [2019, 2018, 2016, 2015, 2011]. Null is returned if user with given username was not found.

    Parameters

    • username: string

      The GitHub username of the user

    Returns Promise<number[] | null>

getIssueContributionsInMonth

getIssueContributionsInYear

  • getIssueContributionsInYear(username: string, year: number): Promise<MonthlyContributions[] | null>

getOrganizationMemberships

  • Returns the organizations that the user is member of. Null is returned if user with given username was not found.

    Parameters

    • username: string

      The GitHub username of the user

    Returns Promise<OrganizationProfileMinified[] | null>

getProfile

  • getProfile(username: string): Promise<UserProfile | null>
  • Returns user profile. Null is returned if user with given username was not found.

    Parameters

    • username: string

      The GitHub username of the user

    Returns Promise<UserProfile | null>

getPublicGists

  • Returns public gists that the user has owns. Null is returned if user with given username was not found.

    Parameters

    • username: string

      The GitHub username of the user

    Returns Promise<GistProfileMinified[] | null>

getPublicRepositoryOwnerships

  • Returns public repositories that the user owns. Null is returned if user with given username was not found.

    Parameters

    • username: string

      The GitHub username of the user

    Returns Promise<RepositoryProfileMinified[] | null>

getPullRequestContributionsInMonth

getPullRequestContributionsInYear

getPullRequestReviewContributionsInMonth

  • getPullRequestReviewContributionsInMonth(username: string, inYear: number, inMonth: Month): Promise<MonthlyContributions | null>

getPullRequestReviewContributionsInYear

  • getPullRequestReviewContributionsInYear(username: string, inYear: number): Promise<MonthlyContributions[] | null>

Generated using TypeDoc