Skip to main content

createGuestModule()

function createGuestModule(
   guestId: string, 
   params?: HostProvidedParams, 
   overrides?: ModuleOverrides): IModule;

Create a module scripting object for a guest micro-app. The host registers this before rendering GuestMicroApp so the guest can pull its init parameters via module.getParameters().

Internally calls buildModuleParams to merge the app config values (hostUrl, manifestPath, homeRoute) with host-provided values (theme, history, initialRoute).

Register the returned object via CMicroAppHost.addScriptingObject or CMicroAppGuest.addScriptingObject (not directly on the app bridge) so it is added to both the App Bridge and the SSF Host.

Parameters​

guestId​

string

App id as defined in app.config.json (e.g. 'loanapp')

params?​

HostProvidedParams = {}

Host-provided values (theme, history, initialRoute, custom keys)

overrides?​

ModuleOverrides = {}

Method overrides / additions (e.g. custom getCapabilities)

Returns​

IModule

IModule scripting object ready for CMicroAppHost/CMicroApp.addScriptingObject()