Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RepositoryRoute

Hierarchy

  • Routefetcher
    • RepositoryRoute

Index

Methods

Methods

getProfile

  • getProfile(ownerName: string, repositoryName: string): Promise<RepositoryProfile | null>
  • Returns repository profile. Null is returned if repository with given parameters was not found.

    Example #1 (user-owned repository): getProfile('torvalds', 'linux')

    Example #2 (organization-owned repository): getProfile('facebook', 'react')

    Parameters

    • ownerName: string

      The GitHub name of the repository owner (i.e. the username if the owner is a user, or the name of a organization if the owner is a organization)

    • repositoryName: string

      The GitHub name of the repository (e.g. 'linux' or 'facebook')

    Returns Promise<RepositoryProfile | null>

Generated using TypeDoc