Class UserAPI

Hierarchy

APIBase
- UserAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey getAllSubscriptions getSubscription setApiKey setApiUrl subscribe unsubscribe updateSubscription

Constructors

constructor

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

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

getAllSubscriptions

getAllSubscriptions(
options?: PaginationOptions,
): Promise<LibrariesIOResult<Subscription[]>>
List packages that a user is subscribed to recieved notifications about new releases.
Parameters
- Optionaloptions: PaginationOptions
  Pagination options
Returns Promise<LibrariesIOResult<Subscription[]>>
- Defined in api/UserAPI.ts:25

getSubscription

getSubscription(
platform: PlatformType,
projectName: string,
): Promise<LibrariesIOResult<Subscription | null>>
Check if a users is subscribed to receive notifications about new releases of a project.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
Returns Promise<LibrariesIOResult<Subscription | null>>
- Defined in api/UserAPI.ts:36

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

subscribe(
    platform: PlatformType,
    projectName: string,
    options?: PreReleaseOptions,
): Promise<LibrariesIOResult<Subscription>>
Subscribe to receive notifications about new releases of a project.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
- Optionaloptions: PreReleaseOptions
  Subscription options
Returns Promise<LibrariesIOResult<Subscription>>
- Defined in api/UserAPI.ts:51

unsubscribe

unsubscribe(
platform: PlatformType,
projectName: string,
): Promise<LibrariesIOHeaders>
Stop receiving release notifications from a project.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
Returns Promise<LibrariesIOHeaders>
- Defined in api/UserAPI.ts:66

updateSubscription

updateSubscription(
    platform: PlatformType,
    projectName: string,
    options?: PreReleaseOptions,
): Promise<LibrariesIOResult<Subscription>>
Update the options for a subscription.
Parameters
- platform: PlatformType
  The project platform (e.g. "npm", "cargo", ...)
- projectName: string
  The project name
- Optionaloptions: PreReleaseOptions
  Subscription options
Returns Promise<LibrariesIOResult<Subscription>>
- Defined in api/UserAPI.ts:78