scdate 2.0.2 → 2.1.0

package/dist/constants.d.ts

@@ -7,3 +7,8 @@ export declare enum Weekday {
     Fri = 32,
     Sat = 64
 }
+/**
+ * Maps weekday index (0-6) to Weekday enum value.
+ * 0 = Sunday, 1 = Monday, ..., 6 = Saturday
+ */
+export declare const DayToWeekday: Weekday[];

package/dist/constants.js

@@ -8,3 +8,16 @@ export var Weekday;
     Weekday[Weekday["Fri"] = 32] = "Fri";
     Weekday[Weekday["Sat"] = 64] = "Sat";
 })(Weekday || (Weekday = {}));
+/**
+ * Maps weekday index (0-6) to Weekday enum value.
+ * 0 = Sunday, 1 = Monday, ..., 6 = Saturday
+ */
+export const DayToWeekday = [
+    Weekday.Sun,
+    Weekday.Mon,
+    Weekday.Tue,
+    Weekday.Wed,
+    Weekday.Thu,
+    Weekday.Fri,
+    Weekday.Sat,
+];

package/dist/internal/constants.d.ts

@@ -1,5 +1,3 @@
-import { Weekday } from '../constants.js';
-export declare const DayToWeekday: Weekday[];
 export declare const DaysInWeek = 7;
 export declare const MinutesInDay = 1440;
 export declare const MinutesInHour = 60;

package/dist/internal/constants.js

@@ -1,13 +1,3 @@
-import { Weekday } from '../constants.js';
-export const DayToWeekday = [
-    Weekday.Sun,
-    Weekday.Mon,
-    Weekday.Tue,
-    Weekday.Wed,
-    Weekday.Thu,
-    Weekday.Fri,
-    Weekday.Sat,
-];
 export const DaysInWeek = 7;
 export const MinutesInDay = 1440;
 export const MinutesInHour = 60;

package/dist/internal/weekdays.js

@@ -1,4 +1,4 @@
-import { DayToWeekday } from './constants.js';
+import { DayToWeekday } from '../constants.js';
 export const validateWeekdays = (weekdays) => {
     const ValidWeekdays = /^[S-][M-][T-][W-][T-][F-][S-]$/;
     if (!ValidWeekdays.test(weekdays)) {

package/dist/sDate.d.ts

@@ -91,11 +91,11 @@ export declare const getDateFromDate: (date: string | SDate) => number;
  */
 export declare const getWeekdayFromDate: (date: string | SDate) => number;
 /**
- * Returns the number of milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC)
- * for the given date in the specified time zone.
+ * Returns the number of milliseconds since the Unix epoch (January 1,
+ * 1970, 00:00:00 UTC) for the given date in the specified time zone.
  *
- * @param date The date to convert to UTC milliseconds. It can be an SDate or a string
- * in the YYYY-MM-DD format.
+ * @param date The date to convert to UTC milliseconds. It can be an
+ * SDate or a string in the YYYY-MM-DD format.
  * @param timeZone The time zone to use when converting the date. See
  * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
  */
@@ -191,18 +191,21 @@ export declare const addDaysToDate: (date: string | SDate, days: number) => SDat
  * number of months to the given date. Because it just adds to the month
  * component of the date, this operation is not affected by time zones.
  *
- * When the original date's day exceeds the number of days in the target month,
- * the function will automatically clamp to the last day of the target month
- * rather than rolling over to the next month. For example, adding 1 month to
- * January 31 will result in February 28/29 (depending on leap year), not March 3.
+ * When the original date's day exceeds the number of days in the
+ * target month, the function will automatically clamp to the last day of
+ * the target month rather than rolling over to the next month. For
+ * example, adding 1 month to January 31 will result in February 28/29
+ * (depending on leap year), not March 3.
  *
- * @param date The date to add months to. It can be an SDate or a string in the
- * YYYY-MM-DD format.
+ * @param date The date to add months to. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  * @param months The number of months to add to the date.
- * @param options Additional options for controlling the behavior of the function.
- * @param options.capToCommonDate When true, if the original date is the 29th,
- * 30th, or 31st, the result will be capped to the 28th of the month (the last
- * date common to all months) rather than the last day of the target month.
+ * @param options Additional options for controlling the behavior of the
+ * function.
+ * @param options.capToCommonDate When true, if the original date is the
+ * 29th, 30th, or 31st, the result will be capped to the 28th of the
+ * month (the last date common to all months) rather than the last day of
+ * the target month.
  * This ensures consistent date handling across all months.
  *
  * @example
@@ -266,33 +269,33 @@ export declare const isSameDate: (date1: string | SDate, date2: string | SDate)
  */
 export declare const isBeforeDate: (date1: string | SDate, date2: string | SDate) => boolean;
 /**
- * Returns true when the first date represents a date that happens on the same
- * date or before the second date and false otherwise.
+ * Returns true when the first date represents a date that happens on the
+ * same date or before the second date and false otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
- * @param date2 The second date to compare. It can be an SDate or a string in the
- * the YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
+ * @param date2 The second date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  */
 export declare const isSameDateOrBefore: (date1: string | SDate, date2: string | SDate) => boolean;
 /**
- * Returns true when the first date represents a date that happens after the
- * second date and false otherwise.
+ * Returns true when the first date represents a date that happens after
+ * the second date and false otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
- * @param date2 The second date to compare. It can be an SDate or a string in the
- * the YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
+ * @param date2 The second date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  */
 export declare const isAfterDate: (date1: string | SDate, date2: string | SDate) => boolean;
 /**
- * Returns true when the first date represents a date that happens on the same
- * date or after the second date and false otherwise.
+ * Returns true when the first date represents a date that happens on the
+ * same date or after the second date and false otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
- * @param date2 The second date to compare. It can be an SDate or a string in the
- * the YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
+ * @param date2 The second date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  */
 export declare const isSameDateOrAfter: (date1: string | SDate, date2: string | SDate) => boolean;
 /**

package/dist/sDate.js

@@ -1,7 +1,8 @@
 import { UTCDateMini } from '@date-fns/utc';
 import { getTimezoneOffset } from 'date-fns-tz';
+import { DayToWeekday } from './constants.js';
 import { SDate } from './internal/SDate.js';
-import { DayToWeekday, DaysInWeek, MillisecondsInDay, } from './internal/constants.js';
+import { DaysInWeek, MillisecondsInDay } from './internal/constants.js';
 import { getDateAsUTCDateMini, getISODateFromISODate, getISODateFromZonedDate, getISOMonthFromISODate, getISOYearFromISODate, } from './internal/date.js';
 import { getAtIndex } from './internal/utils.js';
 import { getIndexForWeekday } from './internal/weekdays.js';
@@ -145,11 +146,11 @@ export const getWeekdayFromDate = (date) => {
     return getAtIndex(DayToWeekday, nativeDate.getDay());
 };
 /**
- * Returns the number of milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC)
- * for the given date in the specified time zone.
+ * Returns the number of milliseconds since the Unix epoch (January 1,
+ * 1970, 00:00:00 UTC) for the given date in the specified time zone.
  *
- * @param date The date to convert to UTC milliseconds. It can be an SDate or a string
- * in the YYYY-MM-DD format.
+ * @param date The date to convert to UTC milliseconds. It can be an
+ * SDate or a string in the YYYY-MM-DD format.
  * @param timeZone The time zone to use when converting the date. See
  * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
  */
@@ -290,18 +291,21 @@ export const addDaysToDate = (date, days) => {
  * number of months to the given date. Because it just adds to the month
  * component of the date, this operation is not affected by time zones.
  *
- * When the original date's day exceeds the number of days in the target month,
- * the function will automatically clamp to the last day of the target month
- * rather than rolling over to the next month. For example, adding 1 month to
- * January 31 will result in February 28/29 (depending on leap year), not March 3.
+ * When the original date's day exceeds the number of days in the
+ * target month, the function will automatically clamp to the last day of
+ * the target month rather than rolling over to the next month. For
+ * example, adding 1 month to January 31 will result in February 28/29
+ * (depending on leap year), not March 3.
  *
- * @param date The date to add months to. It can be an SDate or a string in the
- * YYYY-MM-DD format.
+ * @param date The date to add months to. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  * @param months The number of months to add to the date.
- * @param options Additional options for controlling the behavior of the function.
- * @param options.capToCommonDate When true, if the original date is the 29th,
- * 30th, or 31st, the result will be capped to the 28th of the month (the last
- * date common to all months) rather than the last day of the target month.
+ * @param options Additional options for controlling the behavior of the
+ * function.
+ * @param options.capToCommonDate When true, if the original date is the
+ * 29th, 30th, or 31st, the result will be capped to the 28th of the
+ * month (the last date common to all months) rather than the last day of
+ * the target month.
  * This ensures consistent date handling across all months.
  *
  * @example
@@ -337,7 +341,8 @@ export const addMonthsToDate = (date, months, options) => {
     nativeDate.setDate(1);
     // Then set the new month
     nativeDate.setMonth(currentMonth + months);
-    // If capToCommonDate is true and the original day is greater than 28, cap to 28
+    // If capToCommonDate is true and the original day is greater than
+    // 28, cap to 28
     if (options?.capToCommonDate && currentDay > 28) {
         nativeDate.setDate(28);
     }
@@ -396,13 +401,13 @@ export const isBeforeDate = (date1, date2) => {
     return sDate1.date < sDate2.date;
 };
 /**
- * Returns true when the first date represents a date that happens on the same
- * date or before the second date and false otherwise.
+ * Returns true when the first date represents a date that happens on the
+ * same date or before the second date and false otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
- * @param date2 The second date to compare. It can be an SDate or a string in the
- * the YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
+ * @param date2 The second date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  */
 export const isSameDateOrBefore = (date1, date2) => {
     const sDate1 = sDate(date1);
@@ -410,13 +415,13 @@ export const isSameDateOrBefore = (date1, date2) => {
     return sDate1.date <= sDate2.date;
 };
 /**
- * Returns true when the first date represents a date that happens after the
- * second date and false otherwise.
+ * Returns true when the first date represents a date that happens after
+ * the second date and false otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
- * @param date2 The second date to compare. It can be an SDate or a string in the
- * the YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
+ * @param date2 The second date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  */
 export const isAfterDate = (date1, date2) => {
     const sDate1 = sDate(date1);
@@ -424,13 +429,13 @@ export const isAfterDate = (date1, date2) => {
     return sDate1.date > sDate2.date;
 };
 /**
- * Returns true when the first date represents a date that happens on the same
- * date or after the second date and false otherwise.
+ * Returns true when the first date represents a date that happens on the
+ * same date or after the second date and false otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
- * @param date2 The second date to compare. It can be an SDate or a string in the
- * the YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
+ * @param date2 The second date to compare. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  */
 export const isSameDateOrAfter = (date1, date2) => {
     const sDate1 = sDate(date1);

package/dist/sTimestamp.d.ts

@@ -50,13 +50,16 @@ export declare const getTimestampFromDateAndTime: (date: string | SDate, time: s
  * --- Getters ---
  */
 /**
- * Returns the number of milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC)
- * for the given timestamp in the specified time zone.
- *
- * @param timestamp The timestamp to convert to UTC milliseconds. It can be an STimestamp
- * or a string in the YYYY-MM-DDTHH:MM format.
- * @param timeZone The time zone to use when converting the timestamp. See
- * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
+ * Returns the number of milliseconds since the Unix epoch
+ * (January 1, 1970, 00:00:00 UTC) for the given timestamp in the
+ * specified time zone.
+ *
+ * @param timestamp The timestamp to convert to UTC milliseconds.
+ * It can be an STimestamp or a string in the YYYY-MM-DDTHH:MM
+ * format.
+ * @param timeZone The time zone to use when converting the
+ * timestamp. See `Intl.supportedValuesOf('timeZone')` for a list
+ * of valid time zones.
  */
 export declare const getUTCMillisecondsFromTimestamp: (timestamp: string | STimestamp, timeZone: string) => number;
 /**
@@ -104,16 +107,26 @@ export declare const getTimeZonedDateFromTimestamp: (timestamp: string | STimest
  * In 'America/New_York'
  *
  * Transition to Eastern Daylight Time (EDT) in 2024
- * | Time Zone        | T1                    | T2                     | T3                    |
- * |------------------|-----------------------|------------------------|-----------------------|
- * | America/New_York | 2024-03-10T01:59(EST) | 2024-03-10T02:00(EDT)  | 2024-03-10T03:00(EST) |
- * | UTC              | 2024-03-10T06:59      | 2024-03-10T06:00       | 2024-03-10T07:00      |
+ * | Time Zone        | T1                  | T2                  |
+ * |------------------|---------------------|---------------------|
+ * | America/New_York | 2024-03-10T01:59EST | 2024-03-10T02:00EDT |
+ * | UTC              | 2024-03-10T06:59    | 2024-03-10T06:00    |
+ *
+ * | Time Zone        | T3                  |
+ * |------------------|---------------------|
+ * | America/New_York | 2024-03-10T03:00EST |
+ * | UTC              | 2024-03-10T07:00    |
  *
  * Transition to Eastern Standard Time (EST) in 2024
- * | Time Zone        | T1                    | T2                     | T3                    |
- * |------------------|-----------------------|------------------------|-----------------------|
- * | America/New_York | 2024-11-03T01:59(EDT) | 2024-11-03T02:00(EST)  | 2024-11-03T03:00(EST) |
- * | UTC              | 2024-11-03T05:59      | 2024-11-03T07:00       | 2024-11-03T08:00      |
+ * | Time Zone        | T1                  | T2                  |
+ * |------------------|---------------------|---------------------|
+ * | America/New_York | 2024-11-03T01:59EDT | 2024-11-03T02:00EST |
+ * | UTC              | 2024-11-03T05:59    | 2024-11-03T07:00    |
+ *
+ * | Time Zone        | T3                  |
+ * |------------------|---------------------|
+ * | America/New_York | 2024-11-03T03:00EST |
+ * | UTC              | 2024-11-03T08:00    |
  *
  * @param timestamp The timestamp to get the seconds to. It can be an STimestamp
  * or a string in the YYYY-MM-DDTHH:MM format.
@@ -226,16 +239,26 @@ export declare const addDaysToTimestamp: (timestamp: string | STimestamp, days:
  * In 'America/New_York'
  *
  * Transition to Eastern Daylight Time (EDT) in 2024
- * | Time Zone        | T1                    | T2                     | T3                    |
- * |------------------|-----------------------|------------------------|-----------------------|
- * | America/New_York | 2024-03-10T01:59(EST) | 2024-03-10T02:00(EDT)  | 2024-03-10T03:00(EST) |
- * | UTC              | 2024-03-10T06:59      | 2024-03-10T06:00       | 2024-03-10T07:00      |
+ * | Time Zone        | T1                  | T2                  |
+ * |------------------|---------------------|---------------------|
+ * | America/New_York | 2024-03-10T01:59EST | 2024-03-10T02:00EDT |
+ * | UTC              | 2024-03-10T06:59    | 2024-03-10T06:00    |
+ *
+ * | Time Zone        | T3                  |
+ * |------------------|---------------------|
+ * | America/New_York | 2024-03-10T03:00EST |
+ * | UTC              | 2024-03-10T07:00    |
  *
  * Transition to Eastern Standard Time (EST) in 2024
- * | Time Zone        | T1                    | T2                     | T3                    |
- * |------------------|-----------------------|------------------------|-----------------------|
- * | America/New_York | 2024-11-03T01:59(EDT) | 2024-11-03T02:00(EST)  | 2024-11-03T03:00(EST) |
- * | UTC              | 2024-11-03T05:59      | 2024-11-03T07:00       | 2024-11-03T08:00      |
+ * | Time Zone        | T1                  | T2                  |
+ * |------------------|---------------------|---------------------|
+ * | America/New_York | 2024-11-03T01:59EDT | 2024-11-03T02:00EST |
+ * | UTC              | 2024-11-03T05:59    | 2024-11-03T07:00    |
+ *
+ * | Time Zone        | T3                  |
+ * |------------------|---------------------|
+ * | America/New_York | 2024-11-03T03:00EST |
+ * | UTC              | 2024-11-03T08:00    |
  *
  * @param timestamp The timestamp to add minutes to. It can be an STimestamp or
  * a string in the YYYY-MM-DDTHH:MM format.

package/dist/sTimestamp.js

@@ -64,13 +64,16 @@ export const getTimestampFromDateAndTime = (date, time) => {
  * --- Getters ---
  */
 /**
- * Returns the number of milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC)
- * for the given timestamp in the specified time zone.
- *
- * @param timestamp The timestamp to convert to UTC milliseconds. It can be an STimestamp
- * or a string in the YYYY-MM-DDTHH:MM format.
- * @param timeZone The time zone to use when converting the timestamp. See
- * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
+ * Returns the number of milliseconds since the Unix epoch
+ * (January 1, 1970, 00:00:00 UTC) for the given timestamp in the
+ * specified time zone.
+ *
+ * @param timestamp The timestamp to convert to UTC milliseconds.
+ * It can be an STimestamp or a string in the YYYY-MM-DDTHH:MM
+ * format.
+ * @param timeZone The time zone to use when converting the
+ * timestamp. See `Intl.supportedValuesOf('timeZone')` for a list
+ * of valid time zones.
  */
 export const getUTCMillisecondsFromTimestamp = (timestamp, timeZone) => {
     const sTimestampValue = sTimestamp(timestamp);
@@ -130,16 +133,26 @@ export const getTimeZonedDateFromTimestamp = (timestamp, timeZone) => {
  * In 'America/New_York'
  *
  * Transition to Eastern Daylight Time (EDT) in 2024
- * | Time Zone        | T1                    | T2                     | T3                    |
- * |------------------|-----------------------|------------------------|-----------------------|
- * | America/New_York | 2024-03-10T01:59(EST) | 2024-03-10T02:00(EDT)  | 2024-03-10T03:00(EST) |
- * | UTC              | 2024-03-10T06:59      | 2024-03-10T06:00       | 2024-03-10T07:00      |
+ * | Time Zone        | T1                  | T2                  |
+ * |------------------|---------------------|---------------------|
+ * | America/New_York | 2024-03-10T01:59EST | 2024-03-10T02:00EDT |
+ * | UTC              | 2024-03-10T06:59    | 2024-03-10T06:00    |
+ *
+ * | Time Zone        | T3                  |
+ * |------------------|---------------------|
+ * | America/New_York | 2024-03-10T03:00EST |
+ * | UTC              | 2024-03-10T07:00    |
  *
  * Transition to Eastern Standard Time (EST) in 2024
- * | Time Zone        | T1                    | T2                     | T3                    |
- * |------------------|-----------------------|------------------------|-----------------------|
- * | America/New_York | 2024-11-03T01:59(EDT) | 2024-11-03T02:00(EST)  | 2024-11-03T03:00(EST) |
- * | UTC              | 2024-11-03T05:59      | 2024-11-03T07:00       | 2024-11-03T08:00      |
+ * | Time Zone        | T1                  | T2                  |
+ * |------------------|---------------------|---------------------|
+ * | America/New_York | 2024-11-03T01:59EDT | 2024-11-03T02:00EST |
+ * | UTC              | 2024-11-03T05:59    | 2024-11-03T07:00    |
+ *
+ * | Time Zone        | T3                  |
+ * |------------------|---------------------|
+ * | America/New_York | 2024-11-03T03:00EST |
+ * | UTC              | 2024-11-03T08:00    |
  *
  * @param timestamp The timestamp to get the seconds to. It can be an STimestamp
  * or a string in the YYYY-MM-DDTHH:MM format.
@@ -278,16 +291,26 @@ export const addDaysToTimestamp = (timestamp, days) => {
  * In 'America/New_York'
  *
  * Transition to Eastern Daylight Time (EDT) in 2024
- * | Time Zone        | T1                    | T2                     | T3                    |
- * |------------------|-----------------------|------------------------|-----------------------|
- * | America/New_York | 2024-03-10T01:59(EST) | 2024-03-10T02:00(EDT)  | 2024-03-10T03:00(EST) |
- * | UTC              | 2024-03-10T06:59      | 2024-03-10T06:00       | 2024-03-10T07:00      |
+ * | Time Zone        | T1                  | T2                  |
+ * |------------------|---------------------|---------------------|
+ * | America/New_York | 2024-03-10T01:59EST | 2024-03-10T02:00EDT |
+ * | UTC              | 2024-03-10T06:59    | 2024-03-10T06:00    |
+ *
+ * | Time Zone        | T3                  |
+ * |------------------|---------------------|
+ * | America/New_York | 2024-03-10T03:00EST |
+ * | UTC              | 2024-03-10T07:00    |
  *
  * Transition to Eastern Standard Time (EST) in 2024
- * | Time Zone        | T1                    | T2                     | T3                    |
- * |------------------|-----------------------|------------------------|-----------------------|
- * | America/New_York | 2024-11-03T01:59(EDT) | 2024-11-03T02:00(EST)  | 2024-11-03T03:00(EST) |
- * | UTC              | 2024-11-03T05:59      | 2024-11-03T07:00       | 2024-11-03T08:00      |
+ * | Time Zone        | T1                  | T2                  |
+ * |------------------|---------------------|---------------------|
+ * | America/New_York | 2024-11-03T01:59EDT | 2024-11-03T02:00EST |
+ * | UTC              | 2024-11-03T05:59    | 2024-11-03T07:00    |
+ *
+ * | Time Zone        | T3                  |
+ * |------------------|---------------------|
+ * | America/New_York | 2024-11-03T03:00EST |
+ * | UTC              | 2024-11-03T08:00    |
  *
  * @param timestamp The timestamp to add minutes to. It can be an STimestamp or
  * a string in the YYYY-MM-DDTHH:MM format.

package/dist/sWeekdays.d.ts

@@ -38,9 +38,11 @@ export declare const sWeekdays: (weekdays: string | SWeekdays) => SWeekdays;
  *
  * @example
  * ```ts
- * getWeekdaysFromWeekdayFlags(Weekday.Monday | Weekday.Wednesday | Weekday.Friday)
- * // Returns an instance of SWeekdays with the weekdays Monday, Wednesday, and
- * // Friday included while the rest are excluded.
+ * getWeekdaysFromWeekdayFlags(
+ *   Weekday.Monday | Weekday.Wednesday | Weekday.Friday
+ * )
+ * // Returns an instance of SWeekdays with the weekdays Monday,
+ * // Wednesday, and Friday included while the rest are excluded.
  * ```
  *
  * @example
@@ -62,6 +64,42 @@ export declare const getWeekdaysWithNoneIncluded: () => SWeekdays;
 /**
  * --- Operations ---
  */
+/**
+ * Returns the previous weekday (the day before the provided weekday).
+ *
+ * @param weekday The weekday to get the previous weekday for.
+ *
+ * @example
+ * ```ts
+ * getPreviousWeekday(Weekday.Mon)
+ * // Returns Weekday.Sun
+ * ```
+ *
+ * @example
+ * ```ts
+ * getPreviousWeekday(Weekday.Sun)
+ * // Returns Weekday.Sat
+ * ```
+ */
+export declare const getPreviousWeekday: (weekday: Weekday) => Weekday;
+/**
+ * Returns the next weekday (the day after the provided weekday).
+ *
+ * @param weekday The weekday to get the next weekday for.
+ *
+ * @example
+ * ```ts
+ * getNextWeekday(Weekday.Mon)
+ * // Returns Weekday.Tue
+ * ```
+ *
+ * @example
+ * ```ts
+ * getNextWeekday(Weekday.Sat)
+ * // Returns Weekday.Sun
+ * ```
+ */
+export declare const getNextWeekday: (weekday: Weekday) => Weekday;
 /**
  * Returns a new SWeekdays instance with the weekdays shifted forward by one
  * day.
@@ -126,3 +164,45 @@ export declare const doesWeekdaysIncludeWeekday: (weekdays: string | SWeekdays,
  * SWeekdays or a string in the SMTWTFS format.
  */
 export declare const doesWeekdaysHaveOverlapWithWeekdays: (weekdays1: string | SWeekdays, weekdays2: string | SWeekdays) => boolean;
+/**
+ * Returns true if the two weekdays patterns are equal (have the same days
+ * included). Returns false otherwise.
+ *
+ * @param weekdays1 The first weekdays pattern to compare. It can be an
+ * SWeekdays or a string in the SMTWTFS format.
+ * @param weekdays2 The second weekdays pattern to compare. It can be an
+ * SWeekdays or a string in the SMTWTFS format.
+ *
+ * @example
+ * ```ts
+ * areWeekdaysEqual('SMTWTFS', 'SMTWTFS')
+ * // Returns true
+ * ```
+ *
+ * @example
+ * ```ts
+ * areWeekdaysEqual('SM----S', '-MTWTF-')
+ * // Returns false
+ * ```
+ */
+export declare const areWeekdaysEqual: (weekdays1: string | SWeekdays, weekdays2: string | SWeekdays) => boolean;
+/**
+ * Returns true if the weekdays pattern has no days selected (i.e., '-------').
+ * Returns false otherwise.
+ *
+ * @param weekdays The weekdays pattern to check. It can be an SWeekdays or a
+ * string in the SMTWTFS format.
+ *
+ * @example
+ * ```ts
+ * isWeekdaysEmpty('-------')
+ * // Returns true
+ * ```
+ *
+ * @example
+ * ```ts
+ * isWeekdaysEmpty('S------')
+ * // Returns false (Sunday is included)
+ * ```
+ */
+export declare const isWeekdaysEmpty: (weekdays: string | SWeekdays) => boolean;

package/dist/sWeekdays.js

@@ -1,8 +1,9 @@
 /**
  * --- Factory ---
  */
+import { DayToWeekday } from './constants.js';
 import { SWeekdays } from './internal/SWeekdays.js';
-import { DayToWeekday, DaysInWeek } from './internal/constants.js';
+import { DaysInWeek } from './internal/constants.js';
 import { getAtIndex, hasFlag } from './internal/utils.js';
 import { getIndexForWeekday } from './internal/weekdays.js';
 import { addDaysToDate, getDaysBetweenDates, getWeekdayFromDate, isAfterDate, isSameDateOrBefore, sDate, } from './sDate.js';
@@ -49,9 +50,11 @@ export const sWeekdays = (weekdays) => {
  *
  * @example
  * ```ts
- * getWeekdaysFromWeekdayFlags(Weekday.Monday | Weekday.Wednesday | Weekday.Friday)
- * // Returns an instance of SWeekdays with the weekdays Monday, Wednesday, and
- * // Friday included while the rest are excluded.
+ * getWeekdaysFromWeekdayFlags(
+ *   Weekday.Monday | Weekday.Wednesday | Weekday.Friday
+ * )
+ * // Returns an instance of SWeekdays with the weekdays Monday,
+ * // Wednesday, and Friday included while the rest are excluded.
  * ```
  *
  * @example
@@ -86,6 +89,50 @@ export const getWeekdaysWithNoneIncluded = () => {
 /**
  * --- Operations ---
  */
+/**
+ * Returns the previous weekday (the day before the provided weekday).
+ *
+ * @param weekday The weekday to get the previous weekday for.
+ *
+ * @example
+ * ```ts
+ * getPreviousWeekday(Weekday.Mon)
+ * // Returns Weekday.Sun
+ * ```
+ *
+ * @example
+ * ```ts
+ * getPreviousWeekday(Weekday.Sun)
+ * // Returns Weekday.Sat
+ * ```
+ */
+export const getPreviousWeekday = (weekday) => {
+    const weekdayIndex = getIndexForWeekday(weekday);
+    const previousIndex = (weekdayIndex + DaysInWeek - 1) % DaysInWeek;
+    return getAtIndex(DayToWeekday, previousIndex);
+};
+/**
+ * Returns the next weekday (the day after the provided weekday).
+ *
+ * @param weekday The weekday to get the next weekday for.
+ *
+ * @example
+ * ```ts
+ * getNextWeekday(Weekday.Mon)
+ * // Returns Weekday.Tue
+ * ```
+ *
+ * @example
+ * ```ts
+ * getNextWeekday(Weekday.Sat)
+ * // Returns Weekday.Sun
+ * ```
+ */
+export const getNextWeekday = (weekday) => {
+    const weekdayIndex = getIndexForWeekday(weekday);
+    const nextIndex = (weekdayIndex + 1) % DaysInWeek;
+    return getAtIndex(DayToWeekday, nextIndex);
+};
 /**
  * Returns a new SWeekdays instance with the weekdays shifted forward by one
  * day.
@@ -204,3 +251,51 @@ export const doesWeekdaysHaveOverlapWithWeekdays = (weekdays1, weekdays2) => {
     }
     return false;
 };
+/**
+ * Returns true if the two weekdays patterns are equal (have the same days
+ * included). Returns false otherwise.
+ *
+ * @param weekdays1 The first weekdays pattern to compare. It can be an
+ * SWeekdays or a string in the SMTWTFS format.
+ * @param weekdays2 The second weekdays pattern to compare. It can be an
+ * SWeekdays or a string in the SMTWTFS format.
+ *
+ * @example
+ * ```ts
+ * areWeekdaysEqual('SMTWTFS', 'SMTWTFS')
+ * // Returns true
+ * ```
+ *
+ * @example
+ * ```ts
+ * areWeekdaysEqual('SM----S', '-MTWTF-')
+ * // Returns false
+ * ```
+ */
+export const areWeekdaysEqual = (weekdays1, weekdays2) => {
+    const sWeekdays1 = sWeekdays(weekdays1);
+    const sWeekdays2 = sWeekdays(weekdays2);
+    return sWeekdays1.weekdays === sWeekdays2.weekdays;
+};
+/**
+ * Returns true if the weekdays pattern has no days selected (i.e., '-------').
+ * Returns false otherwise.
+ *
+ * @param weekdays The weekdays pattern to check. It can be an SWeekdays or a
+ * string in the SMTWTFS format.
+ *
+ * @example
+ * ```ts
+ * isWeekdaysEmpty('-------')
+ * // Returns true
+ * ```
+ *
+ * @example
+ * ```ts
+ * isWeekdaysEmpty('S------')
+ * // Returns false (Sunday is included)
+ * ```
+ */
+export const isWeekdaysEmpty = (weekdays) => {
+    return areWeekdaysEqual(weekdays, getWeekdaysWithNoneIncluded());
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scdate",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js"
@@ -12,21 +12,12 @@
   ],
   "sideEffects": false,
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "scripts": {
     "build": "tsc --build",
-    "build:clean": "yarn build --clean && rimraf dist && rimraf *.tgz",
     "lint": "eslint .",
-    "test": "vitest run",
-    "test:utc": "TZ=Etc/Universal yarn test",
-    "test:watch": "vitest",
-    "test:utc:watch": "TZ=Etc/Universal yarn test:watch",
-    "smoke": "yarn build && yarn lint && yarn test:utc",
-    "-- PRE-COMMIT HOOKS --": "",
-    "localAfterInstall": "husky || true",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
+    "test": "vitest run"
   },
   "dependencies": {
     "@date-fns/utc": "^2.1.1",
@@ -34,23 +25,13 @@
     "date-fns-tz": "^3.2.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.33.0",
-    "@tsconfig/strictest": "^2.0.5",
-    "@types/node": "^24.3.0",
-    "eslint": "^9.33.0",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.1.5",
-    "pinst": "^3.0.0",
-    "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.40.0",
-    "vitest": "^3.2.4"
-  },
-  "prettier": {
-    "tabWidth": 2,
-    "semi": false,
-    "singleQuote": true
+    "@eslint/js": "^9.39.1",
+    "@tsconfig/strictest": "^2.0.8",
+    "@types/node": "^24.10.1",
+    "eslint": "^9.39.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.47.0",
+    "vitest": "^4.0.13"
   },
   "repository": {
     "type": "git",
@@ -66,9 +47,7 @@
     "timestamp"
   ],
   "license": "MIT",
-  "lint-staged": {
-    "*.{ts,tsx,mjs}": "eslint --cache",
-    "*": "prettier --ignore-unknown --write"
-  },
-  "packageManager": "yarn@4.9.2"
-}
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Eric Vera
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.