Add a deprecation warning to the format function in date.js, recommen…

…ding the use of formatDate instead
uktrade · Dec 18, 2024 · 0521a01 · 0521a01
1 parent 9c33a32
commit 0521a01
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/src/client/utils/date.js b/src/client/utils/date.js
@@ -120,13 +120,18 @@ function isShortDateValid(year, month) {
 }
 
 /**
- * Date formatting and parsing functions
+ * @deprecated This function is deprecated. Use `formatDate` instead.
+ *
+ * This function will be removed in the near future.
  */
-
 function format(dateStr, dateFormat = DATE_LONG_FORMAT_2) {
   return isDateValid(dateStr) ? formatFns(parseISO(dateStr), dateFormat) : null
 }
 
+/**
+ * Parsing functions
+ */
+
 const padZero = (value) => {
   const parsedValue = parseInt(value, 10)
   if (Number.isNaN(parsedValue)) {