Function defineCommerceEngine (Open Beta)

See Implement server-side rendering.

defineCommerceEngine<
    TControllerDefinitions extends ControllerDefinitionsMap<Controller>,
>(
    options: CommerceEngineDefinitionOptions<TControllerDefinitions>,
): {
    listingEngineDefinition: CommerceEngineDefinition<
        TControllerDefinitions,
        listing,
    >;
    recommendationEngineDefinition: CommerceEngineDefinition<
        TControllerDefinitions,
        recommendation,
    >;
    searchEngineDefinition: CommerceEngineDefinition<
        TControllerDefinitions,
        search,
    >;
    standaloneEngineDefinition: CommerceEngineDefinition<
        TControllerDefinitions,
        standalone,
    >;
}
Initializes a Commerce engine definition in SSR with given controllers definitions and commerce engine config.
Type Parameters
- TControllerDefinitions extends ControllerDefinitionsMap<Controller>
Parameters
- options: CommerceEngineDefinitionOptions<TControllerDefinitions>
  The commerce engine definition
Returns {
    listingEngineDefinition: CommerceEngineDefinition<
        TControllerDefinitions,
        listing,
    >;
    recommendationEngineDefinition: CommerceEngineDefinition<
        TControllerDefinitions,
        recommendation,
    >;
    searchEngineDefinition: CommerceEngineDefinition<
        TControllerDefinitions,
        search,
    >;
    standaloneEngineDefinition: CommerceEngineDefinition<
        TControllerDefinitions,
        standalone,
    >;
}
Three utility functions to fetch the initial state of the engine in SSR, hydrate the state in CSR, and a build function that can be used for edge cases requiring more control.

See Implement server-side rendering.
- listingEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, listing>
  See Implement server-side rendering.
- recommendationEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, recommendation>
  See Implement server-side rendering.
- searchEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, search>
  See Implement server-side rendering.
- standaloneEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, standalone>
  See Implement server-side rendering.
- Defined in packages/headless/src/app/commerce-engine/commerce-engine.ssr.ts:38

Function defineCommerceEngine (Open Beta)

Type Parameters

Parameters

listingEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, listing>

recommendationEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, recommendation>

searchEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, search>

standaloneEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, standalone>

Settings