Skip to content

Commit 1532dbe

Browse files
add documentation
1 parent 0dbaed9 commit 1532dbe

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ The name of the user to use to login to the database
9898
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.
9999
- `xSocket: string`
100100
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.
101+
- `mysql: {version: string, versionIsInstalledOnSystem: boolean}`
102+
An object with two properties. The first one, version, is the version of MySQL Server that is being used for the database. The second one, versionIsInstalledOnSystem, will be true if the MySQL Server that is being used is already installed on the system. versionIsInstalledOnSystem will be false if the MySQL Server version had to be downloaded from the MySQL CDN.
101103
- `stop: () => Promise<void>`
102104
The method to stop the database. The returned promise resolves when the database has successfully stopped.
103105

0 commit comments

Comments
 (0)