adds doc comments

src/logger.js

@@ -33,6 +33,11 @@ export default class Log {
     return this;
   }
 
+  /**
+   * @description logs text to a file
+   * @param  {string} info - the text to log
+   * @returns {this}
+   */
   async infoToFileAsync(info) {
     const rawMessage = info || this.rawMessage;
 
@@ -47,6 +52,11 @@ export default class Log {
     return this;
   }
 
+  /**
+   * @description outputs a message using internal "styles"
+   * @param  {string} info - the info to style
+   * @param  {boolean} showTimestamp=false - whether to show a timestamp
+   */
   static styleInfo(info, showTimestamp = false) {
     return `
 ==============${showTimestamp ? new Date() : ''}===============
@@ -55,6 +65,12 @@ ${info}
 `;
   }
 
+  /**
+   * @description adds a colorful padded box around a message
+   * @param  {string} info - the info to style
+   * @param  {boolean} showTimestamp=false - whether to show a timestamp
+   * @return {boxen} a styled message
+   */
   static boxInfo(info, showTimestamp = false) {
     const options = { padding: 1 };
     if (showTimestamp) {
@@ -64,6 +80,12 @@ ${info}
     return boxen(info, options);
   }
 
+  /**
+   * @description logs a message to the console that is styled
+   * @param  {string} info - the info to style
+   * @param  {boolean} isImportant - whether to give the message a background
+   * @returns {this}
+   */
   toConsole(info, isImportant) {
     const rawMessage = info || this.rawMessage;
     const infoMessage = Log.boxInfo(rawMessage);
@@ -78,6 +100,9 @@ ${info}
     return this;
   }
 
+  /**
+   * @description starts a timer on the log object (you only get one)
+   */
   startTimer() {
     this.timerStart = Date.now();
     if (this.timerEnd) {
@@ -86,12 +111,19 @@ ${info}
     return this;
   }
 
+  /**
+   * @description ends a timer on the log object
+   */
   endTimer() {
     this.timerEnd = Date.now();
 
     return this;
   }
 
+  /**
+   * @description gets the elapsed time
+   * @returns {number} the elapsed time in seconds
+   */
   get elapsedTime() {
     let elapsedTime = null;