Interface RecommendationListState

A scoped and simplified part of the headless state that is relevant to the RecommendationList controller.

interface RecommendationListState {
    error: null | ErrorPayload;
    isLoading: boolean;
    recommendations: Result[];
    searchResponseId: string;
}

Properties

error: null | ErrorPayload

The current error for the last executed query, or null if none is present.

isLoading: boolean

true if a search is in progress and false otherwise.

recommendations: Result[]

The recommendations based on the last executed query.

searchResponseId: string

The unique identifier of the Search API response from which the recommendations were fetched.