feat(types): support type and facet in search methods (#1263)

algolia · Apr 9, 2021 · 54c1cb7 · 54c1cb7
1 parent 3aec216
commit 54c1cb7
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/packages/client-search/src/types/MultipleQueriesQuery.ts b/packages/client-search/src/types/MultipleQueriesQuery.ts
@@ -1,6 +1,13 @@
 import { SearchOptions } from '.';
 
-export type MultipleQueriesQuery = {
+type SharedMultipleQueriesQuery = {
+  /**
+   * The type of query to perform.
+   *
+   * @defaultValue "default"
+   */
+  readonly type?: 'default' | 'facet';
+
   /**
    * The index name.
    */
@@ -16,3 +23,17 @@ export type MultipleQueriesQuery = {
    */
   readonly query?: string;
 };
+
+export type MultipleQueriesQuery = SharedMultipleQueriesQuery &
+  (
+    | {
+        readonly type?: 'default';
+      }
+    | {
+        readonly type: 'facet';
+        /**
+         * The facet name.
+         */
+        readonly facet: string;
+      }
+  );