date-vir 9.2.1 → 9.3.0

package/dist/date-operations/day-of-week.d.ts

@@ -0,0 +1,27 @@
+import { type DayOfWeekName } from '@date-vir/duration';
+import { type FullDate } from '../full-date/full-date-shape.js';
+/**
+ * Get the day of the week that a {@link FullDate} falls on in its own timezone. To get the day of
+ * the week in a different timezone, convert the date first with `toNewTimezone`.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {getDayOfWeek} from 'date-vir';
+ *
+ * getDayOfWeek({
+ *     year: 2026,
+ *     month: 10,
+ *     day: 2,
+ *
+ *     hour: 23,
+ *     minute: 30,
+ *     second: 0,
+ *     millisecond: 0,
+ *
+ *     timezone: 'America/Denver',
+ * }); // outputs `DayOfWeekName.Friday` (even though this is a Saturday in UTC)
+ * ```
+ */
+export declare function getDayOfWeek(date: Readonly<FullDate>): DayOfWeekName;

package/dist/date-operations/day-of-week.js

@@ -0,0 +1,29 @@
+import { dayOfWeekNameOrder } from '@date-vir/duration';
+import { toLuxonDateTime } from '../full-date/luxon-date-time-conversion.js';
+/**
+ * Get the day of the week that a {@link FullDate} falls on in its own timezone. To get the day of
+ * the week in a different timezone, convert the date first with `toNewTimezone`.
+ *
+ * @category Calculation
+ * @example
+ *
+ * ```ts
+ * import {getDayOfWeek} from 'date-vir';
+ *
+ * getDayOfWeek({
+ *     year: 2026,
+ *     month: 10,
+ *     day: 2,
+ *
+ *     hour: 23,
+ *     minute: 30,
+ *     second: 0,
+ *     millisecond: 0,
+ *
+ *     timezone: 'America/Denver',
+ * }); // outputs `DayOfWeekName.Friday` (even though this is a Saturday in UTC)
+ * ```
+ */
+export function getDayOfWeek(date) {
+    return dayOfWeekNameOrder[(toLuxonDateTime(date).weekday % 7)];
+}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './date-operations/calculate-relative-date.js';
 export * from './date-operations/combine-dates.js';
 export * from './date-operations/date-position.js';
+export * from './date-operations/day-of-week.js';
 export * from './date-operations/diff-dates.js';
 export * from './duration-shape.js';
 export * from './extra-utils/end.js';

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from './date-operations/calculate-relative-date.js';
 export * from './date-operations/combine-dates.js';
 export * from './date-operations/date-position.js';
+export * from './date-operations/day-of-week.js';
 export * from './date-operations/diff-dates.js';
 export * from './duration-shape.js';
 export * from './extra-utils/end.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "9.2.1",
+    "version": "9.3.0",
     "description": "Easy and explicit dates and times.",
     "keywords": [
         "date",
@@ -37,7 +37,7 @@
     "dependencies": {
         "@augment-vir/assert": "^32.5.0",
         "@augment-vir/common": "^32.5.0",
-        "@date-vir/duration": "^9.2.1",
+        "@date-vir/duration": "^9.3.0",
         "@types/luxon": "^3.7.5",
         "luxon": "^3.7.2",
         "object-shape-tester": "^6.15.1",