improve parseKeywordValue helper & fix descriptions

AdguardTeam · Nov 9, 2022 · 1a1b621 · 1a1b621
1 parent 852d01d
commit 1a1b621
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/src/helpers/parse-keyword-value.js b/src/helpers/parse-keyword-value.js
@@ -1,23 +1,21 @@
 /**
- * Modify value according to a keyword.
- * Pass initial value if a keyword is not found.
+ * Modifies passed keyword value according to its purpose.
+ * Returns initial value if it's not a keyword.
  * @param {string} rawValue
  * @returns {string}
  */
 export const parseKeywordValue = (rawValue) => {
     const NOW_VALUE_KEYWORD = '$now$';
     const CURRENT_DATE_KEYWORD = '$currentDate$';
 
-    let parsedValue;
+    let parsedValue = rawValue;
 
     if (rawValue === NOW_VALUE_KEYWORD) {
         // Set to current time in ms, e.g 1667915146503
         parsedValue = Date.now().toString();
     } else if (rawValue === CURRENT_DATE_KEYWORD) {
         // Set to current date e.g 'Tue Nov 08 2022 13:53:19 GMT+0300'
         parsedValue = Date();
-    } else {
-        parsedValue = rawValue;
     }
 
     return parsedValue;

diff --git a/src/helpers/storage-utils.js b/src/helpers/storage-utils.js
@@ -1,9 +1,9 @@
 /**
- * Set item to a specified storage
- * @param {Object} storage Storage instance to set item into
+ * Sets item to a specified storage, if it's not full.
+ * @param {Storage} storage storage instance to set item into
  * @param {string} key
  * @param {string} value
- * @param {boolean} shouldLog
+ * @param {boolean} shouldLog determines if helper should log on a failed set attempt
  */
 export const setStorageItem = (storage, key, value, shouldLog) => {
     // eslint-disable-next-line no-console