UNPKG

@js-sugar/date

Version:

A multi-calendar, tree-shakable, extensible, immutable and lightweight date library for JavaScript

github.com/js-sugar/date

26 lines (25 loc) • 1.15 kB
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
import { DateTime } from '../main'; /** * @name setWeekDay * @category Plugins. * @summary Set the day of the week to the given date. * @description Set the day of the week to the given date. * @param {DateTime} date - date - the date to be changed * @param {dayOfWeek} number - day - the day of the week of the new date * @param {weekStartsOn} number - the index of the first day of the week * Sunday:0|Monday:1|Tuesday:2|Wednesday:3|Thursday:4|Friday:5|Saturday:6 * js-sugar/date Month index is 1..12 * @returns {DateTime} the new date with the day of the week set * @example * // Set week day to Sunday, with the default weekStartsOn of Sunday: * // js-sugar/date month index is 1..12 * const result = setDay(new Date(2022, 8, 1), 0) * //=> Thu June 31 2022 00:00:00 (2022/7/31) * * @example * // Set week day to Sunday, with a weekStartsOn of Monday: * // js-sugar/date month index is 1..12 * const result = setDay(new Date(2014, 9, 1), 0, { weekStartsOn: 1 }) * //=> Sun Sep 07 2014 00:00:00 */ export declare function setWeekDay(date: DateTime, dayOfWeek: number, weekStartsOn: number): DateTime;