Updated Type definition for multiSearch return types for better TS support

src/meilisearch.ts

@@ -29,9 +29,8 @@ import {
   CancelTasksQuery,
   DeleteTasksQuery,
   MultiSearchParams,
-  MultiSearchResponse,
-  SearchResponse,
   FederatedMultiSearchParams,
+  MultiSearchResponseOrSearchResponse,
 } from "./types";
 import { HttpRequests } from "./http-requests";
 import { TaskClient, Task } from "./task";
@@ -214,18 +213,13 @@ export class MeiliSearch {
    * @param config - Additional request configuration options
    * @returns Promise containing the search responses
    */
-  multiSearch<T extends Record<string, unknown> = Record<string, any>>(
-    queries: MultiSearchParams,
+  async multiSearch<
+    T1 extends MultiSearchParams | FederatedMultiSearchParams,
+    T2 extends Record<string, unknown> = Record<string, any>,
+  >(
+    queries: T1,
     config?: Partial<Request>,
-  ): Promise<MultiSearchResponse<T>>;
-  multiSearch<T extends Record<string, unknown> = Record<string, any>>(
-    queries: FederatedMultiSearchParams,
-    config?: Partial<Request>,
-  ): Promise<SearchResponse<T>>;
-  async multiSearch<T extends Record<string, unknown> = Record<string, any>>(
-    queries: MultiSearchParams | FederatedMultiSearchParams,
-    config?: Partial<Request>,
-  ): Promise<MultiSearchResponse<T> | SearchResponse<T>> {
+  ): Promise<MultiSearchResponseOrSearchResponse<T1, T2>> {
     const url = `multi-search`;
 
     return await this.httpRequest.post(url, queries, undefined, config);

src/types/types.ts

@@ -299,6 +299,13 @@ export type MultiSearchResponse<T = Record<string, any>> = {
   results: Array<MultiSearchResult<T>>;
 };
 
+export type MultiSearchResponseOrSearchResponse<
+  T1 extends FederatedMultiSearchParams | MultiSearchParams,
+  T2 extends Record<string, unknown> = Record<string, any>,
+> = T1 extends FederatedMultiSearchParams
+  ? SearchResponse<T2>
+  : MultiSearchResponse<T2>;
+
 export type FieldDistribution = {
   [field: string]: number;
 };