Skip to content

Add warning for internal options #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sebastian-Webster merged 2 commits into from
Nov 17, 2024
Merged

Add warning for internal options #145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b12314
add warning for internal options
Sebastian-Webster Nov 17, 2024
40d1ee0
add options text to warning
Sebastian-Webster Nov 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ export async function createDB(opts?: ServerOptions) {
downloadRetries: 10,
initSQLString: ''
}

const suppliedOpts = opts || {};
const suppliedOptsKeys = Object.keys(suppliedOpts);
const internalOpts = ['_DO_NOT_USE_deleteDBAfterStopped', '_DO_NOT_USE_dbPath', '_DO_NOT_USE_binaryDirectoryPath'];

for (const opt of internalOpts) {
if (suppliedOptsKeys.includes(opt)) {
console.warn(`[ mysql-memory-server - Options WARN ]: Creating MySQL database with option ${opt}. This is considered unstable and should not be used externally. Please consider removing this option.`)
}
}

const options: InternalServerOptions = {...defaultOptions, ...opts}

Expand Down