Skip to main content

Function: settlingWeekRange()

settlingWeekRange(period): { end: CalendarDate; start: CalendarDate; } | null

Defined in: src/lib/pay/index.ts:265

The contiguous date span [firstSettlingMonday, lastSettlingSunday] a period's pay draws from — the exact set of entries to fetch. null only if the period somehow contains no Sunday (never for a real ≥13-day bi-monthly half).

Parameters

period

BiMonthlyPeriod

The bi-monthly half to settle.

Returns

{ end: CalendarDate; start: CalendarDate; } | null

The inclusive [start, end] span (first settling Monday to last settling Sunday), or null if the period has no settling week.