comments for getDate method

makeplane · Mar 18, 2024 · f7dc1c7 · f7dc1c7
1 parent 5a90cc0
commit f7dc1c7
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/web/helpers/date-time.helper.ts b/web/helpers/date-time.helper.ts
@@ -201,6 +201,12 @@ export const checkIfDatesAreEqual = (
   return isEqual(parsedDate1, parsedDate2);
 };
 
+/**
+ * This method returns a date from string of type yyyy-mm-dd
+ * This method is recommended to use instead of new Date() as this does not introduce any timezone offsets
+ * @param date 
+ * @returns date or undefined
+ */
 export const getDate = (date: string | Date | undefined | null): Date | undefined => {
   if (!date || date === "") return;