@interopio/desktop API Reference

Options for starting an app instance.

Properties (5)

Property Type Default Required Description
context⚓︎ Record<string, any> x x

Context to pass to the started app instance. If not provided, the context from the app definition will be used if such exists. Otherwise, this will be set to an empty object.
definitionOverride⚓︎ Record<string, any> x x

Key/value pairs of app definition overrides to apply when starting the app instance. The values of the app definition properties specified here will override the values of the respective properties in the already existing app definition.
name⚓︎ string x

Name of the app to start as specified in its app definition.
reuseInstance⚓︎ boolean false x

If true, the platform will attempt to reuse an existing instance of the specified app if such is available.
timeout⚓︎ number 120000 x

Interval in milliseconds to wait for starting the app instance.