scdate 3.1.0 → 3.2.0

package/README.md

@@ -263,6 +263,8 @@ const filteredWeekdays = filterWeekdaysForDates(
   '2023-12-31',
 )
 const updatedWeekdays = addWeekdayToWeekdays(weekdays5, Weekday.Fri) // Add Friday to pattern
+const withoutWednesday = removeWeekdayFromWeekdays(weekdays4, Weekday.Wed) // Remove Wednesday
+const toggled = toggleWeekdayInWeekdays(weekdays2, Weekday.Mon) // Toggle Monday
 
 // Weekday navigation
 const previousDay = getPreviousWeekday(Weekday.Mon) // Returns Weekday.Sun

package/dist/sWeekdays.d.ts

@@ -142,6 +142,25 @@ export declare const filterWeekdaysForDates: (weekdays: string | SWeekdays, from
  * @param weekdayToAdd The weekday to add.
  */
 export declare const addWeekdayToWeekdays: (weekdays: string | SWeekdays, weekdayToAdd: Weekday) => SWeekdays;
+/**
+ * Returns a new SWeekdays instance with the provided weekday removed from the
+ * current set of weekdays.
+ *
+ * @param weekdays The weekdays to remove the weekday from. It can be an
+ * SWeekdays or a string in the SMTWTFS format.
+ * @param weekdayToRemove The weekday to remove.
+ */
+export declare const removeWeekdayFromWeekdays: (weekdays: string | SWeekdays, weekdayToRemove: Weekday) => SWeekdays;
+/**
+ * Returns a new SWeekdays instance with the provided weekday toggled. If the
+ * weekday is currently included, it is removed. If it is excluded, it is
+ * added.
+ *
+ * @param weekdays The weekdays to toggle the weekday in. It can be an
+ * SWeekdays or a string in the SMTWTFS format.
+ * @param weekdayToToggle The weekday to toggle.
+ */
+export declare const toggleWeekdayInWeekdays: (weekdays: string | SWeekdays, weekdayToToggle: Weekday) => SWeekdays;
 /**
  * --- Comparisons ---
  */

package/dist/sWeekdays.js

@@ -215,6 +215,36 @@ export const addWeekdayToWeekdays = (weekdays, weekdayToAdd) => {
     newWeekdays[weekdayIndex] = getAtIndex(AllWeekdaysIncludedMask, weekdayIndex);
     return sWeekdays(newWeekdays.join(''));
 };
+/**
+ * Returns a new SWeekdays instance with the provided weekday removed from the
+ * current set of weekdays.
+ *
+ * @param weekdays The weekdays to remove the weekday from. It can be an
+ * SWeekdays or a string in the SMTWTFS format.
+ * @param weekdayToRemove The weekday to remove.
+ */
+export const removeWeekdayFromWeekdays = (weekdays, weekdayToRemove) => {
+    const sWeekdaysInstance = sWeekdays(weekdays);
+    const newWeekdays = Array.from(sWeekdaysInstance.weekdays);
+    const weekdayIndex = getIndexForWeekday(weekdayToRemove);
+    newWeekdays[weekdayIndex] = NotIncludedDay;
+    return sWeekdays(newWeekdays.join(''));
+};
+/**
+ * Returns a new SWeekdays instance with the provided weekday toggled. If the
+ * weekday is currently included, it is removed. If it is excluded, it is
+ * added.
+ *
+ * @param weekdays The weekdays to toggle the weekday in. It can be an
+ * SWeekdays or a string in the SMTWTFS format.
+ * @param weekdayToToggle The weekday to toggle.
+ */
+export const toggleWeekdayInWeekdays = (weekdays, weekdayToToggle) => {
+    if (doesWeekdaysIncludeWeekday(weekdays, weekdayToToggle)) {
+        return removeWeekdayFromWeekdays(weekdays, weekdayToToggle);
+    }
+    return addWeekdayToWeekdays(weekdays, weekdayToToggle);
+};
 /**
  * --- Comparisons ---
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scdate",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js"