date-fns/src/eachWeekendOfMonth/index.ts


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

import eachWeekendOfInterval from '../eachWeekendOfInterval/index'
import startOfMonth from '../startOfMonth/index'
import endOfMonth from '../endOfMonth/index'
import requiredArgs from '../_lib/requiredArgs/index'

/**
 * @name eachWeekendOfMonth
 * @category Month Helpers
 * @summary List all the Saturdays and Sundays in the given month.
 *
 * @description
 * Get all the Saturdays and Sundays in the given month.
 *
 * @param {Date|Number} date - the given month
 * @returns {Date[]} an array containing all the Saturdays and Sundays
 * @throws {TypeError} 1 argument required
 * @throws {RangeError} The passed date is invalid
 *
 * @example
 * // Lists all Saturdays and Sundays in the given month
 * const result = eachWeekendOfMonth(new Date(2022, 1, 1))
 * //=> [
 * //   Sat Feb 05 2022 00:00:00,
 * //   Sun Feb 06 2022 00:00:00,
 * //   Sat Feb 12 2022 00:00:00,
 * //   Sun Feb 13 2022 00:00:00,
 * //   Sat Feb 19 2022 00:00:00,
 * //   Sun Feb 20 2022 00:00:00,
 * //   Sat Feb 26 2022 00:00:00,
 * //   Sun Feb 27 2022 00:00:00
 * // ]
 */
export default function eachWeekendOfMonth(dirtyDate: Date): Date[] {
  requiredArgs(1, arguments)

  const startDate = startOfMonth(dirtyDate)
  if (isNaN(startDate.getTime()))
    throw new RangeError('The passed date is invalid')

  const endDate = endOfMonth(dirtyDate)
  return eachWeekendOfInterval({ start: startDate, end: endDate })
}