@trackunit/date-and-time-utils 0.0.2 → 0.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/date-and-time-utils",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,6 +9,7 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "dependencies": {
+    "@formatjs/intl-enumerator": "1.3.4",
     "@js-temporal/polyfill": "0.4.3"
   },
   "peerDependencies": {}

package/src/DateAndTimeUtils.d.ts

@@ -787,4 +787,28 @@ export declare const toZonedDateTimeUtil: (date: TemporalDate, timeZoneId?: stri
  * Output: "A"
  */
 export declare const monthNameUtil: (date: TemporalDate, format: TemporalFormatStyle, locale?: string) => string;
+/**
+ * Returns the day name for the given date.
+ *
+ * @param {TemporalDate | Date} date - The temporal or JavaScript Date object to get day name from.
+ * @param {TemporalFormatStyle} [format] - The format options for the name of the day.
+ * @param {string} [locale] - The locale to use for formatting. If not provided, the system's default locale will be used.
+ * @returns {string} The the name of the day from passed date.
+ * @example
+ * const dateString = "2023-04-10"
+ * const date = new Date(dateString);
+ * const dayName = dayNameUtil(date, "long");
+ * Output: "Monday"
+ * @example
+ * const dateString = "2023-04-10"
+ * const date = new Date(dateString);
+ * const dayName = dayNameUtil(date, "short");
+ * Output: "Mon"
+ * @example
+ * const dateString = "2023-04-10"
+ * const date = new Date(dateString);
+ * const dayName = dayNameUtil(date, "narrow");
+ * Output: "M"
+ */
+export declare const dayNameUtil: (date: TemporalDate, format: TemporalFormatStyle, locale?: string) => string;
 export {};