Interface SearchActionCreators

The search action creators.

interface SearchActionCreators {
    executeSearch(): AsyncThunkAction<
        QuerySearchCommerceAPIThunkReturn,
        void,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >;
    fetchMoreProducts(): AsyncThunkAction<
        null
        | QuerySearchCommerceAPIThunkReturn,
        void,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >;
    prepareForSearchWithQuery(
        payload: PrepareForSearchWithQueryPayload,
    ): AsyncThunkAction<
        void,
        PrepareForSearchWithQueryPayload,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >;
    promoteChildToParent(
        payload: PromoteChildToParentPayload,
    ): { payload: PromoteChildToParentPayload; type: string };
}

Methods

executeSearch fetchMoreProducts prepareForSearchWithQuery promoteChildToParent

Methods

executeSearch

  • executeSearch(): AsyncThunkAction<
        QuerySearchCommerceAPIThunkReturn,
        void,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >

    Executes a search query.

    Returns AsyncThunkAction<
        QuerySearchCommerceAPIThunkReturn,
        void,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >

    A dispatchable action.

fetchMoreProducts

  • fetchMoreProducts(): AsyncThunkAction<
        null
        | QuerySearchCommerceAPIThunkReturn,
        void,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >

    Fetches and additional page of products and appends it to the current list.

    Returns AsyncThunkAction<
        null
        | QuerySearchCommerceAPIThunkReturn,
        void,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >

    A dispatchable action.

prepareForSearchWithQuery

  • prepareForSearchWithQuery(
        payload: PrepareForSearchWithQueryPayload,
    ): AsyncThunkAction<
        void,
        PrepareForSearchWithQueryPayload,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >

    Updates the query, resets the pagination, and optionally clears all facets in preparation for a new search query.

    Parameters

    Returns AsyncThunkAction<
        void,
        PrepareForSearchWithQueryPayload,
        AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
    >

    A dispatchable action.

promoteChildToParent

  • promoteChildToParent(
        payload: PromoteChildToParentPayload,
    ): { payload: PromoteChildToParentPayload; type: string }

    Promotes a child product to a parent product.

    Parameters

    • payload: PromoteChildToParentPayload

      The action creator payload.

    Returns { payload: PromoteChildToParentPayload; type: string }

    A dispatchable action.

Settings

Member Visibility

On This Page

Methods