Class PlatformAPI

Hierarchy

APIBase
- PlatformAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey getPlatforms setApiKey setApiUrl

Constructors

constructor

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

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

getPlatforms

getPlatforms(
options?: PaginationOptions,
): Promise<LibrariesIOResult<Platform[]>>
Get list of supported package managers.
Parameters
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Platform[]>>
- Defined in api/PlatformAPI.ts:17

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