ObjectConsumes Config object and creates Puppeteer instance
\n{\n loader: OPTIONAL_LOADER_FUNCTION\n dev: DEV_FLAG\n apps: {\n // Uppercase object key is used as a base for action type and hash name\n app1: {\n bundleLocation: 'app1.js',\n // document element id where app will be attached\n domHook: 'app1',\n // Mounting function accesible of window object\n // should return unmount function\n mountFuncName: 'mountApp1'\n },\n app2: {\n bundleLocation: 'app2.js',\n domHook: 'app2',\n mountFuncName: 'mountApp2'\n },\n },\n}
\nfunctionSubscribes to TOPIC on event buss.\nCallback is executed with payload data each time 'publish' method is run.
\nPromisePublishes event with optional payload.
\nPromise | functionWrapper for store events
\nObjectCreates default actions/events for children apps in config object.\nIt uses subscribe/publish methods.\nRoute names are based on app keys in config object\nFor each app TOPICs are created:
\n${APP}:ACTION, ${APP}:MOUNT, ${APP}:UNMOUNT
\nApps should communicate by using ${APP}:ACTION topic. MOUNT/UNMOUNT actions are resolved automatically.
\nObjectSubscribes to ROUTER:CUSTOM_HASH_CHANGE event\nwhich is run each time url location changes.\nIt publishes ROUTER:NONE_EXISTING_ROUTE event when apps dont match url.\nIt also uses ${APP}:ACTION events for dynamic app mounting.\nApp route names are based on app keys in config object.
\nObjectCreates simple key-value store which also uses publish/subscribe for communication.\nInstead of calling publish/subscribe,\nPuppeteer provides store wrapper for dealing with it.
\nStringReturns name of current active app.
\nObject\nConsumes Config object and creates Puppeteer instance\n\n{\n loader: OPTIONAL_LOADER_FUNCTION\n dev: DEV_FLAG\n apps: {\n // Uppercase object key is used as a base for action type and hash name\n app1: {\n bundleLocation: ['app1.js'],\n // document element id where app will be attached\n domHook: 'app1',\n // Mounting function accesible of window object\n // should return unmount function\n mountFuncName: 'mountApp1'\n },\n app2: {\n bundleLocation: ['app2.js'],\n domHook: 'app2',\n mountFuncName: 'mountApp2'\n },\n },\n}\n\n**Kind**: global function \n**Returns**: Object - Puppeteer instance \n\n| Param | Type |\n| --- | --- |\n| config | Object | \n\n\n\n## subscribe(topic, listener) ⇒ function\nSubscribes to TOPIC on event buss.\nCallback is executed with payload data each time 'publish' method is run.\n\n**Kind**: global function \n**Returns**: function - Unsubscribe function. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| topic | String | Event to subscribe to. |\n| listener | function | Callback function run when topic event is published. |\n\n\n\n## publish(topic, payload) ⇒ Promise\nPublishes event with optional payload.\n\n**Kind**: global function \n**Returns**: Promise - Resolves when all subscribed callbacks finished. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| topic | String | Event to publish. |\n| payload | Object | optional payload object. |\n\n\n\n## store(action, arg) ⇒ Promise \\| function\nWrapper for store events\n\n**Kind**: global function \n**Returns**: Promise \\| function - Returns Promise on GET action / Unsubscribe function on CHANGE \n\n| Param | Type | Description |\n| --- | --- | --- |\n| action | String | Event to publish. (GET|SET|CHANGE) |\n| arg | String \\| Object \\| function | Depending on action. (KEY_STRING|OBJECT|CALLBACK) |\n\n\n\n## generateAppEvents() ⇒ Object\nCreates default actions/events for children apps in config object.\nIt uses subscribe/publish methods.\nRoute names are based on app keys in config object\nFor each app TOPICs are created:\n\n${APP}:ACTION, ${APP}:MOUNT, ${APP}:UNMOUNT\n\nApps should communicate by using ${APP}:ACTION topic. MOUNT/UNMOUNT actions are resolved automatically.\n\n**Kind**: global function \n**Returns**: Object - returns this instance \n\n\n## initiateAppRouter() ⇒ Object\nSubscribes to ROUTER:CUSTOM_HASH_CHANGE event\nwhich is run each time url location changes.\nIt publishes ROUTER:NONE_EXISTING_ROUTE event when apps dont match url.\nIt also uses ${APP}:ACTION events for dynamic app mounting.\nApp route names are based on app keys in config object.\n\n**Kind**: global function \n**Returns**: Object - returns this instance \n\n\n## attachStore(Optional) ⇒ Object\nCreates simple key-value store which also uses publish/subscribe for communication.\nInstead of calling publish/subscribe,\nPuppeteer provides store wrapper for dealing with it.\n\n**Kind**: global function \n**Returns**: Object - returns this instance. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| Optional | Object | initial store. |\n\n\n\n## getActiveApp() ⇒ String\nReturns name of current active app.\n\n**Kind**: global function \n\n","maintainers":[{"name":"kamilmac","email":"kmacinski@gmail.com"}],"time":{"modified":"2022-06-12T20:29:20.598Z","created":"2017-11-13T09:20:49.397Z","0.1.0":"2017-11-13T09:20:49.397Z","0.1.1":"2017-11-13T09:26:06.343Z","0.1.2":"2017-11-13T09:41:55.776Z","0.1.3":"2017-11-13T09:49:40.771Z","0.1.4":"2017-11-13T11:17:34.572Z","0.1.5":"2017-11-13T11:22:29.075Z","0.1.6":"2017-11-13T13:11:44.361Z","0.1.7":"2017-11-14T14:30:52.735Z","0.1.8":"2017-11-14T15:42:11.649Z","0.1.9":"2017-11-14T16:39:30.520Z","0.1.10":"2017-11-14T17:02:33.920Z","0.2.0":"2017-11-15T09:11:12.813Z","0.2.1":"2017-11-15T10:12:21.028Z","0.2.2":"2017-11-15T12:41:45.769Z","0.2.3":"2017-11-15T13:13:02.478Z","0.2.4":"2017-11-15T13:14:16.646Z","0.2.5":"2017-11-15T13:18:06.524Z","0.2.6":"2017-11-15T13:19:13.990Z","0.2.7":"2017-11-16T09:41:21.318Z","0.3.0":"2017-11-16T10:01:19.440Z","0.3.1":"2017-11-21T17:37:28.251Z","0.3.2":"2017-11-21T18:32:15.620Z","0.3.3":"2017-11-22T14:15:08.219Z","0.3.4":"2017-11-22T14:15:57.098Z","0.3.5":"2017-11-22T14:24:02.732Z","0.3.6":"2017-11-22T14:30:13.407Z","0.3.7":"2017-11-22T14:41:53.726Z","0.3.8":"2017-11-22T14:52:14.342Z","0.3.9":"2017-11-22T14:58:29.060Z","0.3.10":"2017-11-22T15:00:29.690Z"},"keywords":[],"author":{"name":"Kamil Macinski","email":"kmacinski@gmail.com"},"license":"ISC","readmeFilename":"README.md","homepage":"https://github.com/kamilmac/puppeteer#readme","repository":{"type":"git","url":"git+https://github.com/kamilmac/puppeteer.git"},"bugs":{"url":"https://github.com/kamilmac/puppeteer/issues"}}