Home > @vsf-enterprise/bigcommerce-theme > UseWishlistInterface

UseWishlistInterface type

Data and methods returned from the useWishlist() composable

Signature:

export declare type UseWishlistInterface = {
    error: Ref<UseWishlistErrors>;
    loading: Ref<boolean>;
    load: () => Promise<void>;
    addItem: (product: Product) => Promise<void>;
    removeItem: (item: WishlistItem) => Promise<void>;
    clear: () => Promise<any>;
    isInWishlist: (product: Product) => boolean;
};

References: UseWishlistErrors, Product, WishlistItem