From a0e03d8a2d4f29f4ff153ca4a0b2218b144e6fd8 Mon Sep 17 00:00:00 2001
From: Brandon Rodriguez <brodriguez8774@gmail.com>
Date: Thu, 17 Dec 2020 20:52:46 -0500
Subject: [PATCH] Document extending log file

---
 src/logging.js | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/src/logging.js b/src/logging.js
index 25b45eb..98982a9 100644
--- a/src/logging.js
+++ b/src/logging.js
@@ -2,6 +2,12 @@
  * Custom logging to create more useful output.
  * Simply include this file at the top of other files to get extra logging logic.
  *
+ * Log Levels:
+ *  * 10 - DEBUG
+ *  * 20 - INFO
+ *  * 30 - WARNING
+ *  * 40 - ERROR
+ *
  * https://git.brandon-rodriguez.com/javascript/custom_logger
  * Version 1.1
  */
@@ -46,10 +52,16 @@ class Logging {
 
 /**
  * Real logging class.
+ *
+ * To extend class with additional logging levels:
+ *  * Define a new "#x_file_logger" at the top of the file, to hold logging file descriptors.
+ *  * In the constructor, copy one of the existing "this.#x_file_logger" sections and adjust for the new log level.
+ *  * Copy one of the existing log level methods and adjust it for the new log level.
+ *  * Finally, if applicable, add the new LogLeveLNum handling to the "#logToFile" method.
  */
 class LoggingClass {
-    test_var = 'test_var string';
-    #console_debug = 'debug test';
+
+    // Define what will ultimately be our log file handlers.
     #debug_file_logger;
     #info_file_logger;
     #warning_file_logger;
-- 
GitLab