Function defineCommerceEngine

defineCommerceEngine<TControllers extends ControllerDefinitionsMap<Controller>>(
    options: CommerceEngineDefinitionOptions<TControllers>,
): {
    controllers: InferControllerHooksMapFromDefinition<TControllers>;
    listingEngineDefinition: ReactCommerceEngineDefinition<
        TControllers,
        listing,
    >;
    recommendationEngineDefinition: ReactCommerceEngineDefinition<
        TControllers,
        recommendation,
    >;
    searchEngineDefinition: ReactCommerceEngineDefinition<TControllers, search>;
    standaloneEngineDefinition: ReactCommerceEngineDefinition<
        TControllers,
        standalone,
    >;
    useEngine: () => CommerceEngine | undefined;
}
Returns engine and controller hooks, and context providers.

See docs.coveo.com/en/obif0156#define-the-commerce-engine-and-controllers
Type Parameters
- TControllers extends ControllerDefinitionsMap<Controller>
Parameters
- options: CommerceEngineDefinitionOptions<TControllers>
Returns {
    controllers: InferControllerHooksMapFromDefinition<TControllers>;
    listingEngineDefinition: ReactCommerceEngineDefinition<
        TControllers,
        listing,
    >;
    recommendationEngineDefinition: ReactCommerceEngineDefinition<
        TControllers,
        recommendation,
    >;
    searchEngineDefinition: ReactCommerceEngineDefinition<TControllers, search>;
    standaloneEngineDefinition: ReactCommerceEngineDefinition<
        TControllers,
        standalone,
    >;
    useEngine: () => CommerceEngine | undefined;
}
- Defined in packages/headless-react/src/ssr-commerce/commerce-engine.tsx:52

Function defineCommerceEngine

Type Parameters

Parameters

Settings