Interface SearchActionCreators

The search action creators.

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

Index

Methods

executeSearch fetchMoreProducts prepareForSearchWithQuery promoteChildToParent

Methods

executeSearch

executeSearch(
    payload?: FetchSearchPayload,
): AsyncThunkAction<
    QuerySearchCommerceAPIThunkReturn,
    FetchSearchPayload
    | undefined,
    AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
>
Executes a search query.
Parameters
- Optionalpayload: FetchSearchPayload
  The action creator payload.
Returns AsyncThunkAction<
    QuerySearchCommerceAPIThunkReturn,
    FetchSearchPayload
    | undefined,
    AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
>
A dispatchable action.
- Defined in packages/headless/src/features/commerce/search/search-actions-loader.ts:32

fetchMoreProducts

fetchMoreProducts(
    payload?: FetchSearchPayload,
): AsyncThunkAction<
    QuerySearchCommerceAPIThunkReturn
    | null,
    FetchSearchPayload | undefined,
    AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
>
Fetches and additional page of products and appends it to the current list.
Parameters
- Optionalpayload: FetchSearchPayload
  The action creator payload.
Returns AsyncThunkAction<
    QuerySearchCommerceAPIThunkReturn
    | null,
    FetchSearchPayload | undefined,
    AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
>
A dispatchable action.
- Defined in packages/headless/src/features/commerce/search/search-actions-loader.ts:46

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
- payload: PrepareForSearchWithQueryPayload
  The action creator payload.
Returns AsyncThunkAction<
    void,
    PrepareForSearchWithQueryPayload,
    AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
>
A dispatchable action.
- Defined in packages/headless/src/features/commerce/search/search-actions-loader.ts:60

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.
- Defined in packages/headless/src/features/commerce/search/search-actions-loader.ts:74

Interface SearchActionCreators

Index

Methods

Methods

executeSearch

Parameters

Returns AsyncThunkAction< QuerySearchCommerceAPIThunkReturn, FetchSearchPayload | undefined, AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,>

fetchMoreProducts

Parameters

Returns AsyncThunkAction< QuerySearchCommerceAPIThunkReturn | null, FetchSearchPayload | undefined, AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,>

prepareForSearchWithQuery

Parameters

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

promoteChildToParent

Parameters

Returns { payload: PromoteChildToParentPayload; type: string }

Settings

Returns AsyncThunkAction<
QuerySearchCommerceAPIThunkReturn,
FetchSearchPayload
| undefined,
AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
>

Returns AsyncThunkAction<
QuerySearchCommerceAPIThunkReturn
| null,
FetchSearchPayload | undefined,
AsyncThunkCommerceOptions<StateNeededByExecuteSearch>,
>

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