mysql-memory-server 1.4.1 → 1.4.2

package/README.md

@@ -13,15 +13,20 @@ Download with your package manager of choice. The package name is `mysql-memory-
 - Node.js 16.6.0 and newer
 - macOS 13+, Windows, or Linux (This package is only tested on Ubuntu 20.04, 22.04, 24.04, and Fedora 40. Other Linux distributions may or may not work at this time.)
 
-Windows only requirements:
+#### Requirements for downloaded MySQL versions
+
+The following requirements only apply if you intend to have `mysql-memory-server` download a version of MySQL to use instead of using an already installed version of MySQL on the system:
+
+Requirements for Windows:
 - `Microsoft Visual C++ 2019 Redistributable Package` needs to be installed
 
-Linux only requirements:
+Requirements for Linux:
 - The `libaio1` or `libaio1t64` package needs to be installed
 - If `libaio1` is not available but `libaio1t64` is, the `ldconfig` command needs to be available to run
-- The `tar` package needs to be installed if you want to use MySQL versions that aren't system installed
+- The `tar` package needs to be installed
+
+#### Currently supported MySQL versions
 
-Currently supported MySQL versions:
 - If using the system installed MySQL server: 8.0.20 and newer
 - If not using the system installed MySQL server: 8.0.39, 8.1.0, 8.2.0, 8.3.0, 8.4.2, 9.0.1
 
@@ -31,15 +36,26 @@ Currently supported MySQL versions:
 import { createDB } from 'mysql-memory-server';
 import sql from 'mysql2/promise'
 
-// Create a new database
+// Create a new database with default options
 const db = await createDB()
 
+//OR
+
+//Create a new database with custom options set
+const db = await createDB({
+        // see Options for the options you can use in this object and their default values
+        // for example:
+        version: '8.4.x'
+})
+
 // Connect to the new database with the port provided
+// The database is initialized with an empty password so use an empty string for the password
 const connection = await sql.createConnection({
         host: '127.0.0.1',
         user: db.username,
         port: db.port,
         database: db.dbName
+        password: ''
 })
 
 // Run your queries here
@@ -52,6 +68,9 @@ await connection.end()
 await db.stop()
 ```
 
+MySQL database initialization can take some time. If you run into a "Timeout exceeded" error with your tests, the timeout should be extended.
+If using Jest, information about how to do this can be found here: https://jestjs.io/docs/jest-object#jestsettimeouttimeout
+
 ## Documentation
 
 ##### `createDB(options: ServerOptions): Promise<MySQLDB>`

package/dist/src/libraries/Executor.js

@@ -393,7 +393,7 @@ _Executor_instances = new WeakSet(), _Executor_execute = function _Executor_exec
                     }
                 }
                 catch (error) {
-                    if (String(error) === 'Error: Lock file is already being held') {
+                    if (String(error).includes('Lock file is already being held')) {
                         this.logger.log('Waiting for lock for libaio copy');
                         await (0, FileLock_1.waitForLock)(copyPath, options);
                         this.logger.log('Lock is gone for libaio copy');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Spin up an ephemeral MySQL database from your JavaScript code",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -27,7 +27,7 @@
     "@babel/preset-env": "^7.25.4",
     "@babel/preset-typescript": "^7.24.7",
     "@types/adm-zip": "^0.5.5",
-    "@types/node": "^22.5.0",
+    "@types/node": "^22.5.4",
     "@types/proper-lockfile": "^4.1.4",
     "@types/semver": "^7.5.8",
     "babel-jest": "^29.7.0",
@@ -36,7 +36,7 @@
     "typescript": "^5.5.4"
   },
   "dependencies": {
-    "adm-zip": "^0.5.15",
+    "adm-zip": "^0.5.16",
     "proper-lockfile": "^4.1.2",
     "semver": "^7.6.3"
   },