fix(NODE-4129): constrain watch type parameter to extend `ChangeStr…

…eam` type parameter (#3183)
mongodb · Mar 30, 2022 · 43ba9fc · 43ba9fc
1 parent 5132bc9
commit 43ba9fc
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/src/collection.ts b/src/collection.ts
@@ -1422,7 +1422,7 @@ export class Collection<TSchema extends Document = Document> {
    * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
    * @param options - Optional settings for the command
    */
-  watch<TLocal = TSchema>(
+  watch<TLocal extends Document = TSchema>(
     pipeline: Document[] = [],
     options: ChangeStreamOptions = {}
   ): ChangeStream<TLocal> {

diff --git a/src/db.ts b/src/db.ts
@@ -722,7 +722,7 @@ export class Db {
    * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
    * @param options - Optional settings for the command
    */
-  watch<TSchema = Document>(
+  watch<TSchema extends Document = Document>(
     pipeline: Document[] = [],
     options: ChangeStreamOptions = {}
   ): ChangeStream<TSchema> {

diff --git a/src/mongo_client.ts b/src/mongo_client.ts
@@ -590,7 +590,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
    * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
    * @param options - Optional settings for the command
    */
-  watch<TSchema = Document>(
+  watch<TSchema extends Document = Document>(
     pipeline: Document[] = [],
     options: ChangeStreamOptions = {}
   ): ChangeStream<TSchema> {