feat: return object from useRecommendations

algolia · May 11, 2021 · bcecce9 · bcecce9
1 parent 565bb83
commit bcecce9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/packages/react-recommendations/src/Recommendations.tsx b/packages/react-recommendations/src/Recommendations.tsx
@@ -29,7 +29,7 @@ function defaultRender<TObject>(props: {
 export function Recommendations<TObject extends ProductRecord>(
   props: RecommendationsProps<TObject>
 ) {
-  const recommendations = useRecommendations<TObject>(props);
+  const { recommendations } = useRecommendations<TObject>(props);
   const render = props.children || defaultRender;
 
   const children = (

diff --git a/packages/react-recommendations/src/useRecommendations.ts b/packages/react-recommendations/src/useRecommendations.ts
@@ -23,6 +23,10 @@ export type UseRecommendationsProps = {
   threshold?: number;
 };
 
+type UseRecommendationReturn<TObject> = {
+  recommendations: TObject[];
+};
+
 function getDefaultedProps(
   props: UseRecommendationsProps
 ): InternalUseRecommendationsProps {
@@ -46,7 +50,7 @@ function getDefaultedProps(
 
 export function useRecommendations<TObject extends ProductRecord>(
   userProps: UseRecommendationsProps
-): TObject[] {
+): UseRecommendationReturn<TObject> {
   const [products, setProducts] = useState<TObject[]>([]);
   const props = useMemo(() => getDefaultedProps(userProps), [userProps]);
 
@@ -97,5 +101,7 @@ export function useRecommendations<TObject extends ProductRecord>(
       });
   }, [props]);
 
-  return products;
+  return {
+    recommendations: products,
+  };
 }