@interopio/browser API Reference

Object with options for starting an application.

Properties (13)

Property Type Default Required Description
awaitInterop⚓︎ boolean true x

If true, will wait for the Interop library to be initialized.
channelId⚓︎ string x x

Name of the Channel which the window will join.
env⚓︎ Record<string, (string)> x x

Key/value pairs that will be merged with the process.env object when spawning a new process for an executable app from the Node.js environment.
height⚓︎ number 400 x

Window height.
ignoreSavedLayout⚓︎ boolean false x

If true, the App Default Layout of the app (last saved bounds, context, window state) will be ignored when starting the app. The app will always start with the bounds, context and state specified in its configuration.
left⚓︎ number 0 x

Distance of the top left window corner from the left edge of the screen.
parameters⚓︎ string x x

Optional parameters that will be passed to the executable app that is to be started. The value will be used as is and no validation will be performed on it.
relativeDirection⚓︎ "top" | "left" | "right" | "bottom" "right" x

Direction ("bottom", "top", "left", "right") of positioning the window relatively to the relativeTo window. Considered only if relativeTo is supplied.
relativeTo⚓︎ string x x

The ID of the window that will be used to relatively position the new window. Can be combined with relativeDirection.
timeout⚓︎ number x x

Interval in seconds to wait for the app to initialize.
top⚓︎ number 0 x

Distance of the top left window corner from the top edge of the screen.
waitForAGMReady⚓︎ boolean x x x
width⚓︎ number 400 x

Window width.