fix: added typings for acquireTimeout option

sidorares · Apr 10, 2024 · ec0fde9 · ec0fde9
1 parent 1e3cf9b
commit ec0fde9
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/test/tsc-build/mysql/createPool/callbacks/createPool.test.ts b/test/tsc-build/mysql/createPool/callbacks/createPool.test.ts
@@ -9,4 +9,8 @@ import { uriAccess, access } from '../../baseConnection.test.js';
 
   uriPool = mysql.createPool(uriAccess);
   pool = mysql.createPool(access);
+  pool = mysql.createPool({
+    ...access,
+    acquireTimeout: 1000,
+  });
 })();
diff --git a/typings/mysql/lib/Pool.d.ts b/typings/mysql/lib/Pool.d.ts
@@ -22,6 +22,13 @@ export interface PoolOptions extends ConnectionOptions {
    */
   connectionLimit?: number;
 
+  /**
+   * The maximum time (in milliseconds) to wait for getting a connection from the pool. (Default: 10 seconds)
+   *
+   * @default 10000
+   */
+  acquireTimeout?: number;
+
   /**
    * The maximum number of idle connections. (Default: same as `connectionLimit`)
    */