TS: Return Connection from createConnection

Fixes #9610 This change fixes the TypeScript type definitions so that we return a full `Connection` object from `createConnection(url)`, not just a `Promise<Connection>`.
Automattic · Dec 1, 2020 · 0d9e3c6 · 0d9e3c6
1 parent 07b1412
commit 0d9e3c6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -56,7 +56,7 @@ declare module "mongoose" {
   export var connections: Connection[];
 
   /** Creates a Connection instance. */
-  export function createConnection(uri: string, options?: ConnectOptions): Promise<Connection>;
+  export function createConnection(uri: string, options?: ConnectOptions): Connection & Promise<Connection>;
   export function createConnection(): Connection;
   export function createConnection(uri: string, options: ConnectOptions, callback: (err: CallbackError, conn: Connection) => void): void;
 

diff --git a/test/typescript/connection.ts b/test/typescript/connection.ts
@@ -8,4 +8,6 @@ conn.openUri('mongodb://localhost:27017/test').then(() => console.log('Connected
 
 createConnection('mongodb://localhost:27017/test', { useNewUrlParser: true }).then((conn: Connection) => {
   conn.host;
-});
+});
+
+createConnection('mongodb://localhost:27017/test').close();