Merge pull request #13792 from mreouven/patch-1

Enhance Mongoose Typings with SearchMeta Interface for Atlas Search
Automattic · Aug 28, 2023 · 90fc4d2 · 90fc4d2
2 parents e36fc48 + f44e169
commit 90fc4d2
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/types/pipelinestage.d.ts b/types/pipelinestage.d.ts
@@ -28,6 +28,7 @@ declare module 'mongoose' {
     | PipelineStage.ReplaceWith
     | PipelineStage.Sample
     | PipelineStage.Search
+    | PipelineStage.SearchMeta
     | PipelineStage.Set
     | PipelineStage.SetWindowFields
     | PipelineStage.Skip
@@ -239,6 +240,20 @@ declare module 'mongoose' {
       }
     }
 
+    export interface SearchMeta {
+      /** [`$searchMeta` reference](https://www.mongodb.com/docs/atlas/atlas-search/query-syntax/#mongodb-pipeline-pipe.-searchMeta) */
+      $searchMeta: {
+        index?: string;
+        highlight?: {
+          /** [`highlightPath` reference](https://docs.atlas.mongodb.com/atlas-search/path-construction/#multiple-field-search) */
+          path: string | string[] | { value: string, multi: string };
+          maxCharsToExamine?: number;
+          maxNumPassages?: number;
+        };
+        [operator: string]: any;
+      }
+    }
+
     export interface Set {
       /** [`$set` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/set/) */
       $set: Record<string, AnyExpression | any>