Class ProjectAPI

Hierarchy

APIBase
- ProjectAPI

Index

Constructors

Properties

Methods

checkApiKey getContributors getDependentRepositories getDependents getProject getProjectWithDependencies getSourceRank getUsage search setApiKey setApiUrl

Constructors

constructor

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

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

getContributors

getContributors(
    platform: PlatformType,
    projectName: string,
    options?: PaginationOptions,
): Promise<LibrariesIOResult<Contributor[]>>
Get users that have contributed to a given project.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Contributor[]>>
- Defined in api/ProjectAPI.ts:30

getDependentRepositories

getDependentRepositories(
    platform: PlatformType,
    projectName: string,
    options?: PaginationOptions,
): Promise<LibrariesIOResult<Repository[]>>
Get repositories that depend on a given project.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Repository[]>>
- Defined in api/ProjectAPI.ts:46

getDependents

getDependents(
    platform: PlatformType,
    projectName: string,
    options?: PaginationOptions,
): Promise<LibrariesIOResult<Project[]>>
Get packages that have at least one version that depends on a given project.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Project[]>>
- Defined in api/ProjectAPI.ts:62

getProject

getProject(
platform: PlatformType,
projectName: string,
): Promise<LibrariesIOResult<Project>>
Get information about a package and it's versions.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
Returns Promise<LibrariesIOResult<Project>>
- Defined in api/ProjectAPI.ts:77

getProjectWithDependencies

getProjectWithDependencies(
    platform: PlatformType,
    projectName: string,
    projectVersion: string,
): Promise<LibrariesIOResult<ProjectWithDependencies>>
Get a list of dependencies for a version of a project, pass latest as version to get dependency info for the latest available version
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
- projectVersion: string
Returns Promise<LibrariesIOResult<ProjectWithDependencies>>
- Defined in api/ProjectAPI.ts:89

getSourceRank

getSourceRank(
platform: PlatformType,
projectName: string,
): Promise<LibrariesIOResult<number>>
Get breakdown of SourceRank score for a given project.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
Returns Promise<LibrariesIOResult<number>>
- Defined in api/ProjectAPI.ts:104

getUsage

getUsage(
platform: PlatformType,
projectName: string,
): Promise<LibrariesIOResult<ProjectUsage>>
Get breakdown of version usage for a given project.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
Returns Promise<LibrariesIOResult<ProjectUsage>>
- Defined in api/ProjectAPI.ts:115

search

search(
query: string,
options?: SearchOptions,
): Promise<LibrariesIOResult<Project[]>>
Search for projects.
Parameters
- query: string
  The search query
- Optionaloptions: SearchOptions
  Sorting, filter and pagination options
Returns Promise<LibrariesIOResult<Project[]>>
- Defined in api/ProjectAPI.ts:126

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 ProjectAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProjectAPI

Properties

Protected ReadonlyapiClient

Protected Readonlyoptions

Methods

ProtectedcheckApiKey

Parameters

Returns void

getContributors

Parameters

Returns Promise<LibrariesIOResult<Contributor[]>>

getDependentRepositories

Parameters

Returns Promise<LibrariesIOResult<Repository[]>>

getDependents

Parameters

Returns Promise<LibrariesIOResult<Project[]>>

getProject

Parameters

Returns Promise<LibrariesIOResult<Project>>

getProjectWithDependencies

Parameters

Returns Promise<LibrariesIOResult<ProjectWithDependencies>>

getSourceRank

Parameters

Returns Promise<LibrariesIOResult<number>>

getUsage

Parameters

Returns Promise<LibrariesIOResult<ProjectUsage>>

search

Parameters

Returns Promise<LibrariesIOResult<Project[]>>

setApiKey

Parameters

Returns void

setApiUrl

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`apiClient

`Protected` `Readonly`options

`Protected`checkApiKey