Add some comments

This commit is contained in:
Louis Lam 2023-10-16 10:18:28 +08:00
parent 8c7dea5219
commit e11aad2d60

View file

@ -12,22 +12,40 @@ const mysql = require("mysql2/promise");
*/ */
class Database { class Database {
/**
* Boostrap database for SQLite
* @type {string}
*/
static templatePath = "./db/kuma.db"; static templatePath = "./db/kuma.db";
/** /**
* Data Dir (Default: ./data) * Data Dir (Default: ./data)
* @type {string}
*/ */
static dataDir; static dataDir;
/** /**
* User Upload Dir (Default: ./data/upload) * User Upload Dir (Default: ./data/upload)
* @type {string}
*/ */
static uploadDir; static uploadDir;
/**
* Chrome Screenshot Dir (Default: ./data/screenshots)
* @type {string}
*/
static screenshotDir; static screenshotDir;
/**
* SQLite file path (Default: ./data/kuma.db)
* @type {string}
*/
static sqlitePath; static sqlitePath;
/**
* For storing Docker TLS certs (Default: ./data/docker-tls)
* @type {string}
*/
static dockerTLSDir; static dockerTLSDir;
/** /**
@ -84,8 +102,8 @@ class Database {
"patch-add-certificate-expiry-status-page.sql": true, "patch-add-certificate-expiry-status-page.sql": true,
"patch-monitor-oauth-cc.sql": true, "patch-monitor-oauth-cc.sql": true,
"patch-add-timeout-monitor.sql": true, "patch-add-timeout-monitor.sql": true,
"patch-add-gamedig-given-port.sql": true, // The last file so far converted to a knex migration file "patch-add-gamedig-given-port.sql": true,
"patch-notification-config.sql": true, "patch-notification-config.sql": true, // The last file so far converted to a knex migration file
}; };
/** /**