defineConfig#

For dynamically configuring applications runtime features.

Usage#

import { defineConfig } from '@modern-js/runtime';

Runtime configurations can usually be configured under the runtime of the modern.config.js, such as the router configuration.

The configuration in modern.config.js is determined at build time, If some configuration parameters are obtained at runtime, or if the configuration parameters are from a module (such as a component), then need use defineConfig API configuration on runtime.

Function Signature#

function defineConfig(Component, config): any;

Input#

• Component: App root Component.
• config: runtime config.

Example#

function App () {
  ...
}

defineConfig(App, {
  router: {
    supportHtml5History: false
  }
})

1. defineConfig can configuring runtime.state、runtime.router etc.

2. defineConfig before configuring a property, such as router, you need to make sure that the modern.config.js has been configured to enable this feature.

3. defineConfig incoming configuration will be merged with the configuration in modern.config.js. Taking router as an example, the final application configuration is as follows:

{
  // From `modern.config.js`
  ...runtime.router
  // From `defineConfig`
  ...config.router
}