UNPKG

@js-sugar/date

Version:

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

github.com/js-sugar/date

17 lines (16 loc) • 687 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { DateTime } from '../main'; /** * @name startOfWeek * @category Plugins. * @summary Return the start of a week for the given date. * @description Return the start of a week for the given date. * @param {DateTime} date - the original date * @param {weekStartsOn} number - the original date. * Sunday:0|Monday:1|Tuesday:2|Wednesday:3|Thursday:4|Friday:5|Saturday:6 * @returns {DateTime} the start of a month * @example * // The start of a week for 2 October 2021 09:50:01: * const result = startOfWeek(new Date(2021, 10, 2, 09, 50, 1)) * //=> Sep 26 2021 00:00:00 */ export declare function startOfWeek(date: DateTime, weekStartsOn: number): DateTime;