Class AppRegistry

Source: appRegistry.ts

Constructors

Constructor

new AppRegistry(appsConfig: AppsConfig, registeredApps?: Omit<RegistryEntry, "isInstalled">[]): AppRegistry

Parameters

appsConfig

AppsConfig

registeredApps?

Omit<RegistryEntry, "isInstalled">[]

Returns

AppRegistry

Properties

appsConfig

readonly appsConfig: AppsConfig

---

state

readonly state: AppRegistryState

Methods

getById()

getById(id: string): RegistryEntry | undefined

Parameters

id

string

Returns

RegistryEntry | undefined

---

installApp()

installApp(target: string, options?: LoadAppOptions): Promise<RegistryEntry>

Install an app. If an entry with ID target already exists, the stored RegistryEntry.packageName is used as the load source. Otherwise target is passed directly to loadApp.

Parameters

target

string

The app ID for looking up an existing entry, or the npm package name / URL to load from.

options?

LoadAppOptions

Returns

Promise<RegistryEntry>

The registry entry for the installed app.

---

uninstallApp()

uninstallApp(id: string): boolean

Parameters

id

string

Returns

boolean

---

destroy()

destroy(): void

Returns

void