BootstrapConfig
Configuration for bootstrap. App and Surface are the framework’s component types (e.g.
Angular Type<unknown>); the SDK never imports a UI framework, so the caller supplies the mount
callbacks.
Type Parameters
Section titled “Type Parameters”App
Surface
Section titled “Surface”Surface
Properties
Section titled “Properties”app: ComponentLoader<App>;Loads the top-level app component; invoked only on an app entrypoint.
contract
Section titled “contract”contract: AppContract;The app’s handshake contract. See AppContract.
fallback?
Section titled “fallback?”optional fallback?: () => Platform;Stand-in Platform when there’s no shell (standalone). Omit to surface the connect error.
Returns
Section titled “Returns”surfaces?
Section titled “surfaces?”optional surfaces?: Record<string, ComponentLoader<Surface>>;Surface loaders keyed by the contract’s surface name; only the matched one is invoked.
Methods
Section titled “Methods”mountApp()
Section titled “mountApp()”mountApp(app, platform): void | Promise<unknown>;Put the app on screen for this framework (the return, e.g. Angular’s ApplicationRef, is awaited).
Parameters
Section titled “Parameters”App
platform
Section titled “platform”Returns
Section titled “Returns”void | Promise<unknown>
mountSurface()?
Section titled “mountSurface()?”optional mountSurface(surface, conn): void | Promise<unknown>;Put a matched surface on screen; required only for apps that provide surfaces.
Parameters
Section titled “Parameters”surface
Section titled “surface”Surface
Returns
Section titled “Returns”void | Promise<unknown>