Interface ContextDefinition

See Implement server-side rendering.

interface ContextDefinition {
    listing: true;
    recommendation: true;
    search: true;
    standalone: true;
    buildWithProps(
        engine: CommerceEngine,
        props?: ContextOptions,
        solutionType?: SolutionType,
    ): Context & ControllerWithKind;
}

Hierarchy

UniversalControllerDefinitionWithProps<Context, ContextOptions>
- ContextDefinition

Index

Methods

Properties

listing recommendation search standalone

Methods

buildWithProps

buildWithProps(
    engine: CommerceEngine,
    props?: ContextOptions,
    solutionType?: SolutionType,
): Context & ControllerWithKind
Creates an instance of the given controller.
Parameters
- engine: CommerceEngine
  The search engine.
- Optionalprops: ContextOptions
  The controller properties.
- OptionalsolutionType: SolutionType
  The type of solution for which the controller should be built (e.g. search or listing). This option only applies to sub-controllers.
Returns Context & ControllerWithKind
The created controller instance.
Inherited from UniversalControllerDefinitionWithProps.buildWithProps
- Defined in packages/headless/src/ssr/commerce/types/controller-definitions.ts:79

Properties

`Internal`listing

listing: true

`Internal`recommendation

recommendation: true

`Internal`search

search: true

`Internal`standalone

standalone: true