SSR search engine

This is for:

Developer

In this article

Initialize
Methods
Engine Controllers

See Implement SSR—Create an engine definition.

Initialize

`defineSearchEngine`

Initializes a Search engine definition in SSR with given controllers definitions and search engine config.

Parameters

options: EngineDefinitionOptions<SearchEngineOptions, TControllers>

The search engine definition

Returns SearchEngineDefinition

Methods

`build`

Builds an engine and its controllers from an engine definition.

Type: Build<TEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>

`fetchStaticState`

Fetches the static state on the server side using your engine definition.

Type: FetchStaticState<TEngine, InferControllersMapFromDefinition<TControllers>, AnyAction, InferControllerStaticStateMapFromDefinitions<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>

`hydrateStaticState`

Fetches the hydrated state on the client side using your engine definition and the static state.

Type: HydrateStaticState<TEngine, InferControllersMapFromDefinition<TControllers>, AnyAction, InferControllerPropsMapFromDefinitions<TControllers>>