@interopio/desktop API Reference

Access via:io.apps.registry

Object that can be used for managing app definitions.

Properties (1)

Property Type Default Required Description
inMemory⚓︎ InMemoryStore x

Object that can be used for handling app definitions dynamically.

6 Methods

get()⚓︎

(options: GetAppOptions) => Promise<Application | null>

Retrieves an app by name.

Parameters (1)

Name Type Required Description
options⚓︎ GetAppOptions

Options for retrieving the app.

getMany()⚓︎

(filter?: AppFilter) => Promise<Application[]>

Retrieves all available apps. You can also provide an optional filter to refine the result.

Parameters (1)

Name Type Required Description
filter⚓︎ AppFilter x

Filter for retrieving apps.

has()⚓︎

(name: string) => Promise<boolean>

Checks if an app exists in the app registry.

Parameters (1)

Name Type Required Description
name⚓︎ string

The name of the app to check.

onAdded()⚓︎

(handler: AppEventHandler<AppAddedEvent>) => Promise<UnsubscribeFunction>

Notifies when an app has been registered in the environment. Returns an unsubscribe function.

Parameters (1)

Name Type Required Description
handler⚓︎ AppEventHandler<AppAddedEvent>

Callback function for handling the event. Receives as an argument an object describing the added app.

onRemoved()⚓︎

(handler: AppEventHandler<AppRemovedEvent>) => Promise<UnsubscribeFunction>

Notifies when an app has been removed from the environment. Returns an unsubscribe function.

Parameters (1)

Name Type Required Description
handler⚓︎ AppEventHandler<AppRemovedEvent>

Callback function for handling the event. Receives as an argument the name of the removed app.

onUpdated()⚓︎

(handler: AppEventHandler<AppUpdatedEvent>) => Promise<UnsubscribeFunction>

Notifies when an app has been updated. Returns an unsubscribe function.

Parameters (1)

Name Type Required Description
handler⚓︎ AppEventHandler<AppUpdatedEvent>

Callback function for handling the event. Receives as an argument an object describing the updated app and the new values of the updated app properties.