mysql2 3.17.5 → 3.18.0

package/lib/base/connection.js

@@ -926,6 +926,12 @@ class BaseConnection extends EventEmitter {
     return this.addCommand(new Commands.ServerHandshake(args));
   }
 
+  [Symbol.dispose]() {
+    if (!this._closing) {
+      this.end();
+    }
+  }
+
   // ===============================================================
   end(callback) {
     if (this.config.isServer) {

package/lib/base/pool.js

@@ -108,6 +108,12 @@ class BasePool extends EventEmitter {
     }
   }
 
+  [Symbol.dispose]() {
+    if (!this._closed) {
+      this.end();
+    }
+  }
+
   end(cb) {
     this._closed = true;
     clearTimeout(this._removeIdleTimeoutConnectionsTimer);

package/lib/base/pool_connection.js

@@ -29,6 +29,10 @@ class BasePoolConnection extends BaseConnection {
     this._pool.releaseConnection(this);
   }
 
+  [Symbol.dispose]() {
+    this.release();
+  }
+
   end(callback) {
     if (this.config.gracefulEnd) {
       this._removeFromPool();

package/lib/pool_cluster.js

@@ -229,6 +229,12 @@ class PoolCluster extends EventEmitter {
     namespace.getConnection(cb);
   }
 
+  [Symbol.dispose]() {
+    if (!this._closed) {
+      this.end();
+    }
+  }
+
   end(callback) {
     const cb =
       callback !== undefined

package/lib/promise/connection.js

@@ -66,6 +66,12 @@ class PromiseConnection extends EventEmitter {
     });
   }
 
+  async [Symbol.asyncDispose]() {
+    if (!this.connection._closing) {
+      await this.end();
+    }
+  }
+
   beginTransaction() {
     const c = this.connection;
     const localErr = new Error();

package/lib/promise/pool.js

@@ -85,6 +85,12 @@ class PromisePool extends EventEmitter {
       });
     });
   }
+
+  async [Symbol.asyncDispose]() {
+    if (!this.pool._closed) {
+      await this.end();
+    }
+  }
 }
 
 (function (functionsToWrap) {

package/lib/promise/pool_connection.js

@@ -14,6 +14,10 @@ class PromisePoolConnection extends PromiseConnection {
       arguments
     );
   }
+
+  async [Symbol.asyncDispose]() {
+    this.release();
+  }
 }
 
 module.exports = PromisePoolConnection;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2",
-  "version": "3.17.5",
+  "version": "3.18.0",
   "description": "fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS",
   "main": "index.js",
   "typings": "typings/mysql/index",

package/promise.d.ts

@@ -65,6 +65,8 @@ export interface Connection extends QueryableAndExecutableBase {
 
   end(options?: any): Promise<void>;
 
+  [Symbol.asyncDispose](): Promise<void>;
+
   destroy(): void;
 
   pause(): void;
@@ -82,6 +84,7 @@ export interface Connection extends QueryableAndExecutableBase {
 export interface PoolConnection extends Connection {
   release(): void;
   connection: Connection;
+  [Symbol.asyncDispose](): Promise<void>;
 }
 
 export interface Pool extends Connection {
@@ -112,6 +115,8 @@ export interface PoolCluster extends EventEmitter {
 
   end(): Promise<void>;
 
+  [Symbol.asyncDispose](): Promise<void>;
+
   getConnection(): Promise<PoolConnection>;
   getConnection(group: string): Promise<PoolConnection>;
   getConnection(group: string, selector: string): Promise<PoolConnection>;

package/promise.js

@@ -134,6 +134,12 @@ class PromisePoolCluster extends EventEmitter {
       });
     });
   }
+
+  async [Symbol.asyncDispose]() {
+    if (!this.poolCluster._closed) {
+      await this.end();
+    }
+  }
 }
 
 /**

package/typings/mysql/lib/Connection.d.ts

@@ -393,6 +393,8 @@ declare class Connection extends QueryableBase(ExecutableBase(EventEmitter)) {
   end(callback?: (err: QueryError | null) => void): void;
   end(options: any, callback?: (err: QueryError | null) => void): void;
 
+  [Symbol.dispose](): void;
+
   destroy(): void;
 
   pause(): void;

package/typings/mysql/lib/Pool.d.ts

@@ -53,6 +53,8 @@ declare class Pool extends QueryableBase(ExecutableBase(EventEmitter)) {
     callback?: (err: NodeJS.ErrnoException | null, ...args: any[]) => any
   ): void;
 
+  [Symbol.dispose](): void;
+
   on(event: string, listener: (...args: any[]) => void): this;
   on(event: 'connection', listener: (connection: PoolConnection) => any): this;
   on(event: 'acquire', listener: (connection: PoolConnection) => any): this;

package/typings/mysql/lib/PoolCluster.d.ts

@@ -56,6 +56,8 @@ declare class PoolCluster extends EventEmitter {
 
   end(callback?: (err: NodeJS.ErrnoException | null) => void): void;
 
+  [Symbol.dispose](): void;
+
   getConnection(
     callback: (
       err: NodeJS.ErrnoException | null,

package/typings/mysql/lib/PoolConnection.d.ts

@@ -4,6 +4,7 @@ import { Pool as PromisePool } from '../../../promise.js';
 declare class PoolConnection extends Connection {
   connection: Connection;
   release(): void;
+  [Symbol.dispose](): void;
   promise(promiseImpl?: PromiseConstructor): PromisePool;
 }