Class GitHubRepositoryAPI

Hierarchy

APIBase
- GitHubRepositoryAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey getProjects getRepository getRepositoryWithDependencies setApiKey setApiUrl

Constructors

constructor

new GitHubRepositoryAPI(
apiClient: APIClient,
options: ClientOptions,
): GitHubRepositoryAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns GitHubRepositoryAPI
Overrides APIBase.constructor
- Defined in api/GitHub/GitHubRepositoryAPI.ts:15

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

`Protected`checkApiKey

checkApiKey(apiName?: string): void
Parameters
- OptionalapiName: string
Returns void
Inherited from APIBase.checkApiKey
- Defined in api/APIBase.ts:30

getProjects

getProjects(
    repositoryOwner: string,
    repositoryName: string,
    options?: PaginationOptions,
): Promise<LibrariesIOResult<Project[]>>
Get a list of packages referencing the given repository.
Parameters
- repositoryOwner: string
  The repository owner
- repositoryName: string
  The repository name
- Optionaloptions: PaginationOptions
  Pagination Options
Returns Promise<LibrariesIOResult<Project[]>>
- Defined in api/GitHub/GitHubRepositoryAPI.ts:25

getRepository

getRepository(
repositoryOwner: string,
repositoryName: string,
): Promise<LibrariesIOResult<RepositoryWithDependencies>>
Get a info for a repository. Currently only works for open source repositories.
Parameters
- repositoryOwner: string
  The repository owner
- repositoryName: string
  The repository name
Returns Promise<LibrariesIOResult<RepositoryWithDependencies>>
- Defined in api/GitHub/GitHubRepositoryAPI.ts:40

getRepositoryWithDependencies

getRepositoryWithDependencies(
repositoryOwner: string,
repositoryName: string,
): Promise<LibrariesIOResult<RepositoryWithDependencies>>
Get a list of dependencies for a repositories. Currently only works for open source repositories.
Parameters
- repositoryOwner: string
  The repository owner
- repositoryName: string
  The repository name
Returns Promise<LibrariesIOResult<RepositoryWithDependencies>>
- Defined in api/GitHub/GitHubRepositoryAPI.ts:54

setApiKey

setApiKey(apiKey: string): void
Set a new API key.
Parameters
- apiKey: string
  The new API key
Returns void
Inherited from APIBase.setApiKey
- Defined in api/APIBase.ts:18

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:26