fix(NODE-3567): correct typing on aggregation out helper (#2967)

mongodb · Sep 1, 2021 · a299a0b · Loksly · Sep 2, 2021 · emadum
1 parent 319f8ae
commit a299a0b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/cursor/aggregation_cursor.ts b/src/cursor/aggregation_cursor.ts
@@ -120,8 +120,8 @@ export class AggregationCursor<TSchema = Document> extends AbstractCursor<TSchem
     return this;
   }
 
-  /** Add a out stage to the aggregation pipeline */
-  out($out: number): this {
+  /** Add an out stage to the aggregation pipeline */
+  out($out: string): this {
     assertUninitialized(this);
     this[kPipeline].push({ $out });
     return this;

diff --git a/test/types/mongodb.test-d.ts b/test/types/mongodb.test-d.ts
@@ -1,4 +1,4 @@
-import { expectType, expectDeprecated } from 'tsd';
+import { expectType, expectDeprecated, expectError } from 'tsd';
 import { MongoClient } from '../../src/mongo_client';
 import { Collection } from '../../src/collection';
 import { AggregationCursor } from '../../src/cursor/aggregation_cursor';
@@ -35,3 +35,7 @@ const composedMap = mappedAgg.map<string>(x => x.toString());
 expectType<AggregationCursor<string>>(composedMap);
 expectType<string | null>(await composedMap.next());
 expectType<string[]>(await composedMap.toArray());
+
+const builtCursor = coll.aggregate();
+expectType<AggregationCursor<Document>>(builtCursor.out('string')); // should allow string values for the out helper
+expectError(builtCursor.out(1)); // should error on non-string values