Skip to main content

Function: getPeriod()

getPeriod(year, month, half): BiMonthlyPeriod

Defined in: src/lib/dates/index.ts:273

Derive a bi-monthly pay period.

  • Half 1: the 1st through the 15th (always 15 days).
  • Half 2: the 16th through the last day of the month (13-16 days).

Parameters

year

number

Calendar year.

month

number

Calendar month, 1-12.

half

PeriodHalf

1 for the first half (1st-15th) or 2 for the second half (16th-end).

Returns

BiMonthlyPeriod

The fully-populated BiMonthlyPeriod.

Throws

DateError via makeDate if month is out of range.