Merge pull request #14690 from tt-public/feat/type-withsession

types(connection): fix return type of withSession()
Automattic · Jun 25, 2024 · f89868b · f89868b
2 parents 31111f2 + cc63f69
commit f89868b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/test/types/connection.test.ts b/test/types/connection.test.ts
@@ -54,6 +54,11 @@ expectType<Promise<void>>(conn.transaction(async(res) => {
   return 'a';
 }, { readConcern: 'majority' }));
 
+expectType<Promise<string>>(conn.withSession(async(res) => {
+  expectType<mongodb.ClientSession>(res);
+  return 'a';
+}));
+
 expectError(conn.user = 'invalid');
 expectError(conn.pass = 'invalid');
 expectError(conn.host = 'invalid');

diff --git a/types/connection.d.ts b/types/connection.d.ts
@@ -247,7 +247,7 @@ declare module 'mongoose' {
     /** Watches the entire underlying database for changes. Similar to [`Model.watch()`](/docs/api/model.html#model_Model-watch). */
     watch<ResultType extends mongodb.Document = any>(pipeline?: Array<any>, options?: mongodb.ChangeStreamOptions): mongodb.ChangeStream<ResultType>;
 
-    withSession<T = any>(executor: (session: ClientSession) => Promise<T>): T;
+    withSession<T = any>(executor: (session: ClientSession) => Promise<T>): Promise<T>;
   }
 
 }