@dereekb/date 13.0.7 → 13.1.0

package/src/lib/date/date.cell.week.d.ts

@@ -6,10 +6,19 @@ import { type YearWeekCode, type YearWeekCodeGroupFactory } from './date.week';
  */
 export type DateCellDayOfWeekFactory = MapFunction<DateCellIndex, DayOfWeek>;
 /**
- * Creates a DateCellDayOfWeekFactory.
+ * Creates a factory that maps a {@link DateCellIndex} to its corresponding {@link DayOfWeek}.
  *
- * @param dayForIndexZero
- * @returns
+ * @param inputDayForIndexZero - the day of the week for index 0 (can be a DayOfWeek number or a Date)
+ * @returns a function that computes the day of the week for any given index
+ *
+ * @example
+ * ```ts
+ * import { Day } from '@dereekb/util';
+ * const dayFactory = dateCellDayOfWeekFactory(Day.MONDAY);
+ * dayFactory(0); // Day.MONDAY
+ * dayFactory(1); // Day.TUESDAY
+ * dayFactory(6); // Day.SUNDAY
+ * ```
  */
 export declare function dateCellDayOfWeekFactory(inputDayForIndexZero: DayOfWeek | Date): DateCellDayOfWeekFactory;
 /**
@@ -19,6 +28,12 @@ export type DateCellIndexYearWeekCodeFactory = (indexOrDate: DateCellIndex | Dat
 export interface DateCellIndexYearWeekCodeConfig {
     readonly timing: DateCellTiming;
 }
+/**
+ * Creates a factory that computes the {@link YearWeekCode} for a given {@link DateCellIndex} or Date, relative to the configured timing.
+ *
+ * @param config - timing configuration to compute dates from indexes
+ * @returns a function that returns the YearWeekCode for a given index or date
+ */
 export declare function dateCellIndexYearWeekCodeFactory(config: DateCellIndexYearWeekCodeConfig): DateCellIndexYearWeekCodeFactory;
 /**
  * MapFunction that reads the relevant date to use for the YearWeekCode calculation from the input item.
@@ -28,4 +43,10 @@ export interface DateCellIndexYearWeekCodeGroupFactoryConfig<B> {
     readonly dateCellIndexReader: DateCellIndexYearWeekCodeReader<B>;
     readonly dateCellIndexYearWeekCodeFactory: DateCellIndexYearWeekCodeFactory | DateCellIndexYearWeekCodeConfig;
 }
+/**
+ * Creates a factory that groups items by their {@link YearWeekCode} based on a DateCellIndex reader and timing.
+ *
+ * @param config - reader and factory configuration
+ * @returns a function that groups input items into YearWeekCode groups
+ */
 export declare function dateCellIndexYearWeekCodeGroupFactory<B>(config: DateCellIndexYearWeekCodeGroupFactoryConfig<B>): YearWeekCodeGroupFactory<B>;