Interface ExternalEngineOptions<State>

interface ExternalEngineOptions<State extends object> {
    configuration: EngineConfiguration;
    loggerOptions?: LoggerOptions;
    middlewares?: Middleware<State>[];
    navigatorContextProvider?: NavigatorContextProvider;
    preloadedState?: State;
}

Type Parameters

  • State extends object

Hierarchy (View Summary)

Properties

configuration loggerOptions? middlewares? navigatorContextProvider? preloadedState?

Properties

configuration

configuration: EngineConfiguration

The global headless engine configuration options.

OptionalloggerOptions

loggerOptions?: LoggerOptions

The logger options.

Optionalmiddlewares

middlewares?: Middleware<State>[]

List of additional middlewares. A middleware is a higher-order function that composes a dispatch function to return a new dispatch function. It is useful for logging actions, performing side effects like routing, or turning an asynchronous API call into a series of synchronous actions.

Example

type MiddlewareAPI = { dispatch: Dispatch, getState: () => State }
type Middleware = (api: MiddlewareAPI) => (next: Dispatch) => Dispatch

Redux documentation on middlewares.

OptionalnavigatorContextProvider

navigatorContextProvider?: NavigatorContextProvider

An optional function returning navigation context. (referer, location, UserAgent)

OptionalpreloadedState

preloadedState?: State

The initial headless state. You may optionally specify it to hydrate the state from the server in universal apps, or to restore a previously serialized user session.

Settings

Member Visibility

On This Page

Properties