The createOvermind factory is used to create the application instance. You need to create and export a mechanism to connect your instance to the components. Please look at the guides for each view layer for more information.
h(Example, { name: "api/app_initialize" })
You can pass a second argument to the createOvermind factory. This is an options object with the following properties:
It is possible to listen to all mutations performed in Overmind. This allows you to create special effects based on mutations within a certain domain of your app, or whatever else you come up with. Note that this method triggers before the mutation occurs, you might rather want to use addFlushListener to be notified about batched changes, like the components does.
h(Example, { name: "api/app_addMutationListener" })
The addMutationListener triggers whenever there is a mutation. The addFlushListener triggers whenever Overmind tells components to render again. It can have multiple mutations related to it.
h(Example, { name: "api/app_addFlushListener" })
If you develop your app on localhost the application connects to the devtools on localhost:3031. You can change this in case you need to use an IP address, the devtools is configured with a different port or you want to connect to localhost (with default port) even though the app is not on localhost.
h(Example, { name: "api/app_options_devtools" })
By default, in development, Overmind will make sure that any usage of console.log will log out the actual object/array, instead of any proxy wrapping it. This is most likely what you want. If you want to turn off this behaviour, set this option to true.
h(Example, { name: "api/app_options_logproxies" })
If you have multiple instances of Overmind on the same page you can name your app to differentiate them.
h(Example, { name: "api/app_options_name" })
By default Overmind will do the necessary hot reloading mechanism to keep your state, actions and effects updated. You might not want to use this feature or Overmind does not correctly detect that hot reloading should be turned off. You can turn it off with an option.
h(Example, { name: "api/app_options_hotreloading" })