Interface RecommendationList

The RecommendationList controller retrieves information about the current recommendations by the search API, if there are any.

Example: recommendation-list.fn.tsx

interface RecommendationList {
    state: RecommendationListState;
    refresh(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- RecommendationList

Index

Methods

refresh subscribe

Properties

Methods

refresh

refresh(): void
Gets new recommendations.

Returns void
- Defined in packages/headless/src/controllers/recommendation/headless-recommendation.ts:57

subscribe

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

state

state: RecommendationListState

The state relevant to the RecommendationList controller.