change internal options

Author: Sebastian-Webster

README.md

@@ -250,14 +250,8 @@ Default: `TMPDIR/mysqlmsn/binaries` (replacing TMPDIR with the OS temp directory
 
 Description: The folder to store the MySQL binaries when they are downloaded from the CDN.
 
-- `_DO_NOT_USE_beforeSignalCleanupMessage: string`
+- `_DO_NOT_USE_cli: boolean`
 
-Default: undefined
-
-Description: The message to get displayed in the console before the cleanup that happens when the Node.js process is stopped without the ```stop()``` method being called first.
-
-- `_DO_NOT_USE_afterSignalCleanupMessage: string`
-
-Default: undefined
+Default: ```false``` if the package is not being executed via the CLI and ```true``` if it is.
 
-Description: The message to get displayed in the console after the cleanup that happens when the Node.js process is stopped without the ```stop()``` method being called first.
+Description: If set to ```true```, this enables certain CLI-only functionality. For example, when ran by the CLI, logging a message to the console when a shutdown signal (like CTRL + C) has been received and the MySQL database is shutting down and getting deleted.

src/cli.ts

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 import { createDB } from "./index";
 import { OPTION_TYPE_CHECKS } from "./constants";
+import { ServerOptions } from "../types";
 
 async function main() {
     const definedOptions = process.argv.filter((option) => option.startsWith('--'))
-    const options = {
-        _DO_NOT_USE_beforeSignalCleanupMessage: '\nShutting down the ephemeral MySQL database and cleaning all related files...',
-        _DO_NOT_USE_afterSignalCleanupMessage: 'Shutdown and cleanup is complete.'
+    const options: ServerOptions = {
+        _DO_NOT_USE_cli: true
     }
     for (const opt of definedOptions) {
         const index = process.argv.indexOf(opt)

src/constants.ts

@@ -25,8 +25,7 @@ export const DEFAULT_OPTIONS_GENERATOR: () => InternalServerOptions = () => ({
     //mysqlmsn = MySQL Memory Server Node.js
     _DO_NOT_USE_dbPath: normalizePath(`${tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
     _DO_NOT_USE_binaryDirectoryPath: `${tmpdir()}/mysqlmsn/binaries`,
-    _DO_NOT_USE_beforeSignalCleanupMessage: '',
-    _DO_NOT_USE_afterSignalCleanupMessage: ''
+    _DO_NOT_USE_cli: false
 });
 
 export const DEFAULT_OPTIONS_KEYS = Object.freeze(Object.keys(DEFAULT_OPTIONS_GENERATOR()))
@@ -126,14 +125,9 @@ export const OPTION_TYPE_CHECKS: OptionTypeChecks = {
         errorMessage: 'Option _DO_NOT_USE_binaryDirectoryPath must be either undefined or a string.',
         definedType: 'string'
     },
-    _DO_NOT_USE_beforeSignalCleanupMessage: {
-        check: (opt: any) => opt === undefined || typeof opt === 'string',
-        errorMessage: 'Option _DO_NOT_USE_beforeSignalCleanup must be either undefined or a string.',
-        definedType: 'string'
-    },
-    _DO_NOT_USE_afterSignalCleanupMessage: {
-        check: (opt: any) => opt === undefined || typeof opt === 'string',
-        errorMessage: 'Option _DO_NOT_USE_afterSignalCleanup must be either undefined or a string.',
-        definedType: 'string'
+    _DO_NOT_USE_cli: {
+        check: (opt: any) => opt === undefined || typeof opt === 'boolean',
+        errorMessage: 'Option _DO_NOT_USE_cli must be either undefined or a boolean.',
+        definedType: 'boolean'
     }
 } as const;

src/libraries/Executor.ts

@@ -425,8 +425,8 @@ class Executor {
     async startMySQL(options: InternalServerOptions, installedMySQLBinary: InstalledMySQLVersion): Promise<MySQLDB> {
         this.version = installedMySQLBinary.version
         this.removeExitHandler = onExit(() => {
-            if (options._DO_NOT_USE_beforeSignalCleanupMessage) {
-                console.log(options._DO_NOT_USE_beforeSignalCleanupMessage)
+            if (options._DO_NOT_USE_cli) {
+                console.log('\nShutting down the ephemeral MySQL database and cleaning all related files...')
             }
 
             this.DBDestroySignal.abort()
@@ -448,8 +448,8 @@ class Executor {
                 }
             }
 
-            if (options._DO_NOT_USE_afterSignalCleanupMessage) {
-                console.log(options._DO_NOT_USE_afterSignalCleanupMessage)
+            if (options._DO_NOT_USE_cli) {
+                console.log('Shutdown and cleanup is complete.')
             }
         })
 

types/index.ts

@@ -20,8 +20,7 @@ export type ServerOptions = {
     _DO_NOT_USE_deleteDBAfterStopped?: boolean | undefined,
     _DO_NOT_USE_dbPath?: string | undefined,
     _DO_NOT_USE_binaryDirectoryPath?: string | undefined,
-    _DO_NOT_USE_beforeSignalCleanupMessage?: string | undefined,
-    _DO_NOT_USE_afterSignalCleanupMessage?: string | undefined
+    _DO_NOT_USE_cli?: boolean | undefined
 }
 
 export type InternalServerOptions = {
@@ -42,8 +41,7 @@ export type InternalServerOptions = {
     _DO_NOT_USE_deleteDBAfterStopped: boolean,
     _DO_NOT_USE_dbPath: string,
     _DO_NOT_USE_binaryDirectoryPath: string,
-    _DO_NOT_USE_beforeSignalCleanupMessage: string,
-    _DO_NOT_USE_afterSignalCleanupMessage: string
+    _DO_NOT_USE_cli: boolean
 }
 
 export type ExecutorOptions = {