fix(types): add $top and $topN aggregation operators

Fix #12053
Automattic · Jul 5, 2022 · aa46617 · aa46617
1 parent 81c410a
commit aa46617
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/test/types/expressions.test.ts b/test/types/expressions.test.ts
@@ -78,6 +78,14 @@ const timewithOffset430DateToString: Expression = { $dateToString: { format: '%H
 const minutesOffsetNYDateToString: Expression = { $dateToString: { format: '%Z', date: '$date', timezone: 'America/New_York' } };
 const minutesOffset430DateToString: Expression = { $dateToString: { format: '%Z', date: '$date', timezone: '+04:30' } };
 
+const topN: Expression.TopN = {
+  $topN: {
+    output: ['$playerId', '$score'],
+    sortBy: { score: 1 },
+    n: 3
+  }
+};
+
 const dateSubtract1: Expression = {
   $dateSubtract:
   {

diff --git a/types/expressions.d.ts b/types/expressions.d.ts
@@ -2316,6 +2316,21 @@ declare module 'mongoose' {
       $toObjectId: Expression;
     }
 
+    export interface Top {
+      $top: {
+        sortBy: AnyObject,
+        output: Expression
+      };
+    }
+
+    export interface TopN {
+      $topN: {
+        n: Expression,
+        sortBy: AnyObject,
+        output: Expression
+      };
+    }
+
     export interface ToString {
       /**
        * Converts a value to a string. If the value cannot be converted to a string, $toString errors. If the value is
@@ -2407,6 +2422,8 @@ declare module 'mongoose' {
     AccumulatorOperator |
     VariableExpressionOperator |
     WindowOperator |
+    Expression.Top |
+    Expression.TopN |
     any;
 
   export type NullExpression = null;