Merge pull request #142 from Sebastian-Webster/138-expose-socket-pathname-after-database-creation

Expose socket on database creation

Author: Sebastian-Webster

README.md

@@ -86,6 +86,10 @@ The port that MySQLX is listening on
 The database that was created on database initialization
 - `username: string`
 The name of the user to use to login to the database
+- `socket: string`
+If on Windows, this is the name of the named pipe that MySQL is listening on. If not on Windows, this is the path to the socket that MySQL is listening on.
+- `xSocket: string`
+If on Windows, this is the name of the named pipe that the MySQL X Plugin is listening on. If not on Windows, this is the path that the MySQL X Plugin is listening on.
 - `stop: () => Promise<void>`
 The method to stop the database. The returned promise resolves when the database has successfully stopped.
 

src/libraries/Executor.ts

@@ -173,6 +173,8 @@ class Executor {
                         resolve({
                             port,
                             xPort: mySQLXPort,
+                            socket,
+                            xSocket,
                             dbName: options.dbName,
                             username: options.username,
                             stop: () => {

types/index.ts

@@ -53,6 +53,8 @@ export type ExecuteFileReturn = {
 export type MySQLDB = {
     port: number,
     xPort: number,
+    socket: string,
+    xSocket: string,
     dbName: string,
     username: string,
     stop: () => Promise<void>