From bcc02c1680ab032ce2602b2e3a2ae0dd9c97d1b3 Mon Sep 17 00:00:00 2001
From: Adam Stachowicz <adam.stachowicz@fingo.info>
Date: Sun, 19 Sep 2021 23:09:52 +0200
Subject: [PATCH] Add formatting and comments from `util.ts` to `util.js`

---
 src/util.js | 43 +++++++++++++++++++++++++++++++++++++++++++
 src/util.ts | 14 ++++++--------
 2 files changed, 49 insertions(+), 8 deletions(-)

diff --git a/src/util.js b/src/util.js
index 14c68321..1c2b31fa 100644
--- a/src/util.js
+++ b/src/util.js
@@ -1,56 +1,85 @@
+// Common Util for frontend and backend
+// Backend uses the compiled file util.js
+// Frontend uses util.ts
+// Need to run "tsc" to compile if there are any changes.
+
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRandomInt = exports.getRandomArbitrary = exports.TimeLogger = exports.polyfill = exports.debug = exports.ucfirst = exports.sleep = exports.flipStatus = exports.PENDING = exports.UP = exports.DOWN = exports.appName = exports.isDev = void 0;
 const _dayjs = require("dayjs");
 const dayjs = _dayjs;
+
 exports.isDev = process.env.NODE_ENV === "development";
 exports.appName = "Uptime Kuma";
 exports.DOWN = 0;
 exports.UP = 1;
 exports.PENDING = 2;
+
 function flipStatus(s) {
     if (s === exports.UP) {
         return exports.DOWN;
     }
+
     if (s === exports.DOWN) {
         return exports.UP;
     }
+
     return s;
 }
 exports.flipStatus = flipStatus;
+
 function sleep(ms) {
     return new Promise(resolve => setTimeout(resolve, ms));
 }
 exports.sleep = sleep;
+
+/**
+ * PHP's ucfirst
+ * @param str
+ */
 function ucfirst(str) {
     if (!str) {
         return str;
     }
+
     const firstLetter = str.substr(0, 1);
     return firstLetter.toUpperCase() + str.substr(1);
 }
 exports.ucfirst = ucfirst;
+
 function debug(msg) {
     if (exports.isDev) {
         console.log(msg);
     }
 }
 exports.debug = debug;
+
+/**
+ * String.prototype.replaceAll() polyfill
+ * https://gomakethings.com/how-to-replace-a-section-of-a-string-with-another-one-with-vanilla-js/
+ * @author Chris Ferdinandi
+ * @license MIT
+ */
 function polyfill() {
     if (!String.prototype.replaceAll) {
         String.prototype.replaceAll = function (str, newStr) {
+            // If a regex pattern
             if (Object.prototype.toString.call(str).toLowerCase() === "[object regexp]") {
                 return this.replace(str, newStr);
             }
+
+            // If a string
             return this.replace(new RegExp(str, "g"), newStr);
         };
     }
 }
 exports.polyfill = polyfill;
+
 class TimeLogger {
     constructor() {
         this.startTime = dayjs().valueOf();
     }
+
     print(name) {
         if (exports.isDev) {
             console.log(name + ": " + (dayjs().valueOf() - this.startTime) + "ms");
@@ -58,10 +87,24 @@ class TimeLogger {
     }
 }
 exports.TimeLogger = TimeLogger;
+
+/**
+ * Returns a random number between min (inclusive) and max (exclusive)
+ */
 function getRandomArbitrary(min, max) {
     return Math.random() * (max - min) + min;
 }
 exports.getRandomArbitrary = getRandomArbitrary;
+
+/**
+ * From: https://stackoverflow.com/questions/1527803/generating-random-whole-numbers-in-javascript-in-a-specific-range
+ *
+ * Returns a random integer between min (inclusive) and max (inclusive).
+ * The value is no lower than min (or the next integer greater than min
+ * if min isn't an integer) and no greater than max (or the next integer
+ * lower than max if max isn't an integer).
+ * Using Math.round() will give you a non-uniform distribution!
+ */
 function getRandomInt(min, max) {
     min = Math.ceil(min);
     max = Math.floor(max);
diff --git a/src/util.ts b/src/util.ts
index 3b96f7b9..d69c9183 100644
--- a/src/util.ts
+++ b/src/util.ts
@@ -50,16 +50,15 @@ export function debug(msg: any) {
 
 declare global { interface String { replaceAll(str: string, newStr: string): string; } }
 
+/**
+ * String.prototype.replaceAll() polyfill
+ * https://gomakethings.com/how-to-replace-a-section-of-a-string-with-another-one-with-vanilla-js/
+ * @author Chris Ferdinandi
+ * @license MIT
+ */
 export function polyfill() {
-    /**
-     * String.prototype.replaceAll() polyfill
-     * https://gomakethings.com/how-to-replace-a-section-of-a-string-with-another-one-with-vanilla-js/
-     * @author Chris Ferdinandi
-     * @license MIT
-     */
     if (!String.prototype.replaceAll) {
         String.prototype.replaceAll = function (str: string, newStr: string) {
-
             // If a regex pattern
             if (Object.prototype.toString.call(str).toLowerCase() === "[object regexp]") {
                 return this.replace(str, newStr);
@@ -67,7 +66,6 @@ export function polyfill() {
 
             // If a string
             return this.replace(new RegExp(str, "g"), newStr);
-
         };
     }
 }