Preparing search index...
The search index is not available
@coveo/headless-react
@coveo/headless-react
SSR Commerce
index
Build
Type Alias Build<TEngineOptions, TControllersMap, TControllersProps, TControllersDefinitionsMap, TSolutionType>
Build
:
(
...
params
:
OptionsTuple
<
BuildOptions
<
TEngineOptions
>
&
OptionalEngineDefinitionControllersPropsOption
<
TControllersDefinitionsMap
,
TControllersProps
,
TSolutionType
,
>
&
RequiredEngineDefinitionControllersPropsOption
<
TControllersDefinitionsMap
,
TControllersProps
,
TSolutionType
,
>
,
>
,
)
=>
Promise
<
EngineDefinitionBuildResult
<
CommerceEngine
,
TControllersMap
>
>
Type Parameters
TEngineOptions
TControllersMap
extends
ControllersMap
TControllersProps
extends
ControllersPropsMap
TControllersDefinitionsMap
extends
ControllerDefinitionsMap
<
Controller
>
TSolutionType
extends
SolutionType
Type declaration
(
...
params
:
OptionsTuple
<
BuildOptions
<
TEngineOptions
>
&
OptionalEngineDefinitionControllersPropsOption
<
TControllersDefinitionsMap
,
TControllersProps
,
TSolutionType
,
>
&
RequiredEngineDefinitionControllersPropsOption
<
TControllersDefinitionsMap
,
TControllersProps
,
TSolutionType
,
>
,
>
,
)
:
Promise
<
EngineDefinitionBuildResult
<
CommerceEngine
,
TControllersMap
>
>
Initializes an engine and controllers from the definition.
Parameters
...
params
:
OptionsTuple
<
BuildOptions
<
TEngineOptions
>
&
OptionalEngineDefinitionControllersPropsOption
<
TControllersDefinitionsMap
,
TControllersProps
,
TSolutionType
,
>
&
RequiredEngineDefinitionControllersPropsOption
<
TControllersDefinitionsMap
,
TControllersProps
,
TSolutionType
,
>
,
>
Returns
Promise
<
EngineDefinitionBuildResult
<
CommerceEngine
,
TControllersMap
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@coveo/headless-react
Loading...
Initializes an engine and controllers from the definition.