Class LightningServices

Hierarchy

LightningServices

Index

Methods

Methods

deregisterService

deregisterService(serviceName: string, version: string): void

- Defined in main.d.ts:819
Parameters
- serviceName: string
- version: string
Returns void

findClosestService

findClosestService(serviceName: string, version: string): typeof LightningService | undefined

- Defined in main.d.ts:815
Parameters
- serviceName: string
- version: string
Returns typeof LightningService | undefined

getDownloadableServices

getDownloadableServices(role?: SiteServiceRole): Promise<DownloadableServices>

- Defined in main.d.ts:833
Parameters
- Optional role: SiteServiceRole
Returns Promise<DownloadableServices>

getLatestVersion

getLatestVersion(serviceName: string, site: Site): LightningService | null

- Defined in main.d.ts:827
Parameters
- serviceName: string
- site: Site
Returns LightningService | null

getRegisteredServices

getRegisteredServices(): RegisteredServices

- Defined in main.d.ts:835
Returns RegisteredServices

getRequiredDownloads

getRequiredDownloads(services: {}): Promise<DownloaderQueueItem[]>

- Defined in main.d.ts:831
Parameters
- services: {}
  - [service: string]: string
Returns Promise<DownloaderQueueItem[]>

getServices

getServices(): Promise<{}>

- Defined in main.d.ts:841
Returns Promise<{}>

getSiteService

getSiteService(site: Site, serviceName: string): LightningService | null

- Defined in main.d.ts:823
Parameters
- site: Site
- serviceName: string
Returns LightningService | null

getSiteServiceByRole

getSiteServiceByRole(site: Site, role: SiteServiceRole): LightningService | null

- Defined in main.d.ts:825
Parameters
- site: Site
- role: SiteServiceRole
Returns LightningService | null

getSiteServices

getSiteServices(site: Site): LightningService[]

- Defined in main.d.ts:821
Parameters
- site: Site
Returns LightningService[]

hasCurrentPlatformBins

hasCurrentPlatformBins(bins: LightningService["bins"] | DownloadableService["bins"]): boolean

- Defined in main.d.ts:837
Parameters
- bins: LightningService["bins"] | DownloadableService["bins"]
Returns boolean

maybeDownload

maybeDownload(site: Site): Promise<void>

- Defined in main.d.ts:829
Parameters
- site: Site
Returns Promise<void>

registerService

registerService(service: typeof LightningService, serviceName: string, version: string): void

- Defined in main.d.ts:817
Parameters
- service: typeof LightningService
- serviceName: string
- version: string
Returns void

satisfiesEngineRequirement

satisfiesEngineRequirement(service: DownloadableService): boolean

- Defined in main.d.ts:839
Parameters
- service: DownloadableService
Returns boolean

Generated using TypeDoc