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

package/index.cjs.js

@@ -991,6 +991,34 @@ const monthNameUtil = (date, format, locale) => {
         month: format,
     });
 };
+/**
+ * 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"
+ */
+const dayNameUtil = (date, format, locale) => {
+    return toZonedDateTimeUtil(date).toLocaleString(locale, {
+        weekday: format,
+    });
+};
 
 exports.addDaysUtil = addDaysUtil;
 exports.addHoursUtil = addHoursUtil;
@@ -998,6 +1026,7 @@ exports.addMinutesUtil = addMinutesUtil;
 exports.addMonthsUtil = addMonthsUtil;
 exports.addWeeksUtil = addWeeksUtil;
 exports.addYearsUtil = addYearsUtil;
+exports.dayNameUtil = dayNameUtil;
 exports.differenceInDaysUtil = differenceInDaysUtil;
 exports.differenceInHoursUtil = differenceInHoursUtil;
 exports.differenceInMinutesUtil = differenceInMinutesUtil;

package/index.esm.js

@@ -987,5 +987,33 @@ const monthNameUtil = (date, format, locale) => {
         month: format,
     });
 };
+/**
+ * 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"
+ */
+const dayNameUtil = (date, format, locale) => {
+    return toZonedDateTimeUtil(date).toLocaleString(locale, {
+        weekday: format,
+    });
+};
 
-export { addDaysUtil, addHoursUtil, addMinutesUtil, addMonthsUtil, addWeeksUtil, addYearsUtil, differenceInDaysUtil, differenceInHoursUtil, differenceInMinutesUtil, differenceInMonthsUtil, differenceInWeeksUtil, endOfDayUtil, endOfHourUtil, endOfMinuteUtil, endOfMonthUtil, endOfWeekUtil, formatDateUtil, formatRangeUtil, isEqualUtil, isFutureUtil, isPastUtil, isSameDayUtil, isSameMonthUtil, isSameWeekUtil, isSameYearUtil, isTodayUtil, monthNameUtil, startOfDayUtil, startOfHourUtil, startOfMinuteUtil, startOfMonthUtil, startOfWeekUtil, subtractDaysUtil, subtractHoursUtil, subtractMinutesUtil, subtractMonthsUtil, subtractWeeksUtil, subtractYearsUtil, timeSinceAuto, timeSinceInDays, timeSinceInHours, timeSinceInMinutes, timeSinceInMonths, timeSinceInSeconds, timeSinceInYears, timeZonesAvailable, toDateUtil, toInstantUtil, toTemporalUtil, toZonedDateTimeUtil };
+export { addDaysUtil, addHoursUtil, addMinutesUtil, addMonthsUtil, addWeeksUtil, addYearsUtil, dayNameUtil, differenceInDaysUtil, differenceInHoursUtil, differenceInMinutesUtil, differenceInMonthsUtil, differenceInWeeksUtil, endOfDayUtil, endOfHourUtil, endOfMinuteUtil, endOfMonthUtil, endOfWeekUtil, formatDateUtil, formatRangeUtil, isEqualUtil, isFutureUtil, isPastUtil, isSameDayUtil, isSameMonthUtil, isSameWeekUtil, isSameYearUtil, isTodayUtil, monthNameUtil, startOfDayUtil, startOfHourUtil, startOfMinuteUtil, startOfMonthUtil, startOfWeekUtil, subtractDaysUtil, subtractHoursUtil, subtractMinutesUtil, subtractMonthsUtil, subtractWeeksUtil, subtractYearsUtil, timeSinceAuto, timeSinceInDays, timeSinceInHours, timeSinceInMinutes, timeSinceInMonths, timeSinceInSeconds, timeSinceInYears, timeZonesAvailable, toDateUtil, toInstantUtil, toTemporalUtil, toZonedDateTimeUtil };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/date-and-time-utils",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

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 {};