@coveo/headless-react
    Preparing search index...

    Interface RecommendationsDefinition

    interface RecommendationsDefinition {
        recommendation: true;
        buildWithProps(
            engine: CommerceEngine,
            props?: Partial<RecommendationsOptions>,
            solutionType?: SolutionType,
        ): Recommendations & ControllerWithKind;
    }

    Hierarchy

    • RecommendationOnlyControllerDefinitionWithProps<
          Recommendations,
          Partial<RecommendationsOptions>,
      >
      • RecommendationsDefinition
    Index

    Methods

    Properties

    Methods

    • Creates an instance of the given controller.

      Parameters

      • engine: CommerceEngine

        The search engine.

      • Optionalprops: Partial<RecommendationsOptions>

        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 Recommendations & ControllerWithKind

      The created controller instance.

    Properties

    recommendation: true