Class GitHubUserAPI

Hierarchy

APIBase
- GitHubUserAPI

Index

Constructors

Properties

Methods

checkApiKey getContributedProjects getContributedRepositories getDependencies getProjects getRepositories getUser setApiKey setApiUrl

Constructors

constructor

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

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

getContributedProjects

getContributedProjects(
userName: string,
options?: PaginationOptions,
): Promise<LibrariesIOResult<Project[]>>
Get a list of packages that the given user has contributed to.
Parameters
- userName: string
  The username
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Project[]>>
- Defined in api/GitHub/GitHubUserAPI.ts:27

getContributedRepositories

getContributedRepositories(
userName: string,
options?: PaginationOptions,
): Promise<LibrariesIOResult<Repository[]>>
Get a list of repositories that the given user has contributed to.
Parameters
- userName: string
  The username
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Repository[]>>
- Defined in api/GitHub/GitHubUserAPI.ts:41

getDependencies

getDependencies(
userName: string,
options?: PaginationOptions,
): Promise<LibrariesIOResult<Project[]>>
Parameters
- userName: string
- Optionaloptions: PaginationOptions
Returns Promise<LibrariesIOResult<Project[]>>
- Defined in api/GitHub/GitHubUserAPI.ts:50
getDependencies(
    userName: string,
    platform?: PlatformType,
    options?: PaginationOptions,
): Promise<LibrariesIOResult<Project[]>>
Parameters
- userName: string
- Optionalplatform: PlatformType
- Optionaloptions: PaginationOptions
Returns Promise<LibrariesIOResult<Project[]>>
- Defined in api/GitHub/GitHubUserAPI.ts:51

getProjects

getProjects(
userName: string,
options?: PaginationOptions,
): Promise<LibrariesIOResult<Project[]>>
Get a list of packages referencing the given user's repositories.
Parameters
- userName: string
  The username
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Project[]>>
- Defined in api/GitHub/GitHubUserAPI.ts:90

getRepositories

getRepositories(
userName: string,
options?: PaginationOptions,
): Promise<LibrariesIOResult<Repository[]>>
Get repositories owned by a user.
Parameters
- userName: string
  The username
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Repository[]>>
- Defined in api/GitHub/GitHubUserAPI.ts:101

getUser

getUser(userName: string): Promise<LibrariesIOResult<Contributor>>
Get information for a given user or organization.
Parameters
- userName: string
  The username
Returns Promise<LibrariesIOResult<Contributor>>
- Defined in api/GitHub/GitHubUserAPI.ts:114

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

Class GitHubUserAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GitHubUserAPI

Properties

Protected ReadonlyapiClient

Protected Readonlyoptions

Methods

ProtectedcheckApiKey

Parameters

Returns void

getContributedProjects

Parameters

Returns Promise<LibrariesIOResult<Project[]>>

getContributedRepositories

Parameters

Returns Promise<LibrariesIOResult<Repository[]>>

getDependencies

Parameters

Returns Promise<LibrariesIOResult<Project[]>>

Parameters

Returns Promise<LibrariesIOResult<Project[]>>

getProjects

Parameters

Returns Promise<LibrariesIOResult<Project[]>>

getRepositories

Parameters

Returns Promise<LibrariesIOResult<Repository[]>>

getUser

Parameters

Returns Promise<LibrariesIOResult<Contributor>>

setApiKey

Parameters

Returns void

setApiUrl

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`apiClient

`Protected` `Readonly`options

`Protected`checkApiKey