Interface RecommendationActionCreators

The recommendation action creators.

See Dispatch actions.

interface RecommendationActionCreators {
    getRecommendations(): AsyncThunkAction<
        GetRecommendationsThunkReturn,
        void,
        AsyncThunkSearchOptions<StateNeededByGetRecommendations>,
    >;
    setRecommendationId(
        payload: SetRecommendationIdActionCreatorPayload,
    ): { payload: SetRecommendationIdActionCreatorPayload; type: string };
}

Index

Methods

getRecommendations setRecommendationId

Methods

getRecommendations

getRecommendations(): AsyncThunkAction<
    GetRecommendationsThunkReturn,
    void,
    AsyncThunkSearchOptions<StateNeededByGetRecommendations>,
>
Refreshes the recommendations.

Returns AsyncThunkAction<
    GetRecommendationsThunkReturn,
    void,
    AsyncThunkSearchOptions<StateNeededByGetRecommendations>,
>
A dispatchable action.
- Defined in packages/headless/src/features/recommendation/recommendation-actions-loader.ts:27

setRecommendationId

setRecommendationId(
payload: SetRecommendationIdActionCreatorPayload,
): { payload: SetRecommendationIdActionCreatorPayload; type: string }
Updates the recommendation identifier.
Parameters
- payload: SetRecommendationIdActionCreatorPayload
  The action creator payload.
Returns { payload: SetRecommendationIdActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/recommendation/recommendation-actions-loader.ts:39