Interface ProductListingActionCreators

The product listing action creators.

interface ProductListingActionCreators {
    fetchMoreProducts(): AsyncThunkAction<
        null
        | QueryCommerceAPIThunkReturn,
        void,
        AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
    >;
    fetchProductListing(): AsyncThunkAction<
        QueryCommerceAPIThunkReturn,
        void,
        AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
    >;
    promoteChildToParent(
        payload: PromoteChildToParentPayload,
    ): { payload: PromoteChildToParentPayload; type: string };
}

Index

Methods

fetchMoreProducts fetchProductListing promoteChildToParent

Methods

fetchMoreProducts

fetchMoreProducts(): AsyncThunkAction<
    null
    | QueryCommerceAPIThunkReturn,
    void,
    AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
>
Fetches and additional page of products and appends it to the current list.

Returns AsyncThunkAction<
    null
    | QueryCommerceAPIThunkReturn,
    void,
    AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
>
A dispatchable action.
- Defined in packages/headless/src/features/commerce/product-listing/product-listing-actions-loader.ts:37

fetchProductListing

fetchProductListing(): AsyncThunkAction<
    QueryCommerceAPIThunkReturn,
    void,
    AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
>
Refreshes the product listing.

Returns AsyncThunkAction<
    QueryCommerceAPIThunkReturn,
    void,
    AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
>
A dispatchable action.
- Defined in packages/headless/src/features/commerce/product-listing/product-listing-actions-loader.ts:26

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/product-listing/product-listing-actions-loader.ts:49

Interface ProductListingActionCreators

Index

Methods

Methods

fetchMoreProducts

Returns AsyncThunkAction<
    null
    | QueryCommerceAPIThunkReturn,
    void,
    AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
>

fetchProductListing

Returns AsyncThunkAction<
    QueryCommerceAPIThunkReturn,
    void,
    AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
>

promoteChildToParent

Parameters

Returns { payload: PromoteChildToParentPayload; type: string }

Settings

On This Page

Interface ProductListingActionCreators

Index

Methods

Methods

fetchMoreProducts

Returns AsyncThunkAction< null | QueryCommerceAPIThunkReturn, void, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,>

fetchProductListing

Returns AsyncThunkAction< QueryCommerceAPIThunkReturn, void, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,>

promoteChildToParent

Parameters

Returns { payload: PromoteChildToParentPayload; type: string }

Settings

On This Page

Returns AsyncThunkAction<
null
| QueryCommerceAPIThunkReturn,
void,
AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
>

Returns AsyncThunkAction<
QueryCommerceAPIThunkReturn,
void,
AsyncThunkCommerceOptions<StateNeededByFetchProductListing>,
>