`IWishlistRemoveResponse`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IWishlistRemoveResponse

Wishlist removal result and current count.

src/lib/interfaces/orionplace/products/IWishlist.ts

TypeScript

export interface IWishlistRemoveResponse {
  // Field or general errors; check before updating the displayed state.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message, or null.
  success_message: string | null;
  // Current wishlist count, including certain error responses.
  page_data: {
    // Number of saved products the wishlist page lists (only products currently
    // visible in the store) after the operation. It can also accompany an
    // error, so it does not prove success.
    count: number;
  } | null;
}