refactor: removed unnecessary todo comment, modified jsdoc of utility…

… func (#5164)
louislam · Oct 9, 2024 · e8c6507 · e8c6507
1 parent eca90a2
commit e8c6507
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/server/notification-providers/dingding.js b/server/notification-providers/dingding.js
@@ -87,7 +87,6 @@ class DingDing extends NotificationProvider {
      * @returns {string} Status
      */
     statusToString(status) {
-        // TODO: Move to notification-provider.js to avoid repetition in classes
         switch (status) {
             case DOWN:
                 return "DOWN";

diff --git a/src/util.js b/src/util.js
@@ -458,4 +458,4 @@ async function evaluateJsonQuery(data, jsonPath, jsonPathOperator, expectedValue
         throw new Error(`Error evaluating JSON query: ${err.message}. Response from server was: ${response}`);
     }
 }
-exports.evaluateJsonQuery = evaluateJsonQuery;
+exports.evaluateJsonQuery = evaluateJsonQuery;
diff --git a/src/util.ts b/src/util.ts
@@ -120,7 +120,11 @@ export const badgeConstants = {
     defaultCertExpireDownDays: "7"
 };
 
-/** Flip the status of s */
+/**
+ * Flip the status of s between UP and DOWN if this is possible
+ * @param s {number} status
+ * @returns {number} flipped status
+ */
 export function flipStatus(s: number) {
     if (s === UP) {
         return DOWN;