Merge pull request #15233 from Automattic/vkarpov15/gh-15209

types: add missing $median operator to aggregation types
Automattic · Feb 4, 2025 · bd53c4c · bd53c4c
2 parents 52f3ced + 2de289b
commit bd53c4c
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/test/types/expressions.test.ts b/test/types/expressions.test.ts
@@ -313,3 +313,7 @@ const filterLimit: Expression.Filter = {
     }
   ];
 })();
+
+function gh15209() {
+  const query: PipelineStage[] = [{ $group: { _id: null, median: { $median: { input: '$value', method: 'approximate' } } } }];
+}
diff --git a/types/expressions.d.ts b/types/expressions.d.ts
@@ -2301,6 +2301,18 @@ declare module 'mongoose' {
       }
     }
 
+    export interface Median {
+      /**
+       * Returns an approximation of the median, the 50th percentile, as a scalar value.
+       *
+       * @see https://www.mongodb.com/docs/v7.0/reference/operator/aggregation/median/
+       */
+      $median: {
+        input: number | Expression,
+        method: 'approximate'
+      }
+    }
+
     export interface StdDevPop {
       /**
        * Calculates the population standard deviation of the input values. Use if the values encompass the entire
@@ -2859,6 +2871,7 @@ declare module 'mongoose' {
     Expression.Locf |
     Expression.Max |
     Expression.MaxN |
+    Expression.Median |
     Expression.Min |
     Expression.MinN |
     Expression.Push |
@@ -2891,6 +2904,7 @@ declare module 'mongoose' {
     Expression.ExpMovingAvg |
     Expression.Integral |
     Expression.Max |
+    Expression.Median |
     Expression.Min |
     Expression.StdDevPop |
     Expression.StdDevSamp |
@@ -2963,6 +2977,7 @@ declare module 'mongoose' {
     Expression.LastN |
     Expression.Max |
     Expression.MaxN |
+    Expression.Median |
     Expression.MergeObjects |
     Expression.Min |
     Expression.MinN |
-Original file line number
+Diff line change
@@ Expand Up / @@ -313,3 +313,7 @@ const filterLimit: Expression.Filter = { @@
         }
       ];
     })();
+    function gh15209() {
+      const query: PipelineStage[] = [{ $group: { _id: null, median: { $median: { input: '$value', method: 'approximate' } } } }];
+    }