diff options
Diffstat (limited to 'date-fns/src/startOfISOWeek/index.ts')
-rw-r--r-- | date-fns/src/startOfISOWeek/index.ts | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/date-fns/src/startOfISOWeek/index.ts b/date-fns/src/startOfISOWeek/index.ts new file mode 100644 index 0000000..e4d8718 --- /dev/null +++ b/date-fns/src/startOfISOWeek/index.ts @@ -0,0 +1,32 @@ +import startOfWeek from '../startOfWeek/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name startOfISOWeek + * @category ISO Week Helpers + * @summary Return the start of an ISO week for the given date. + * + * @description + * Return the start of an ISO week for the given date. + * The result will be in the local timezone. + * + * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date + * + * ### v2.0.0 breaking changes: + * + * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes). + * + * @param {Date|Number} date - the original date + * @returns {Date} the start of an ISO week + * @throws {TypeError} 1 argument required + * + * @example + * // The start of an ISO week for 2 September 2014 11:55:00: + * var result = startOfISOWeek(new Date(2014, 8, 2, 11, 55, 0)) + * //=> Mon Sep 01 2014 00:00:00 + */ +export default function startOfISOWeek(dirtyDate: Date | number): Date { + requiredArgs(1, arguments) + + return startOfWeek(dirtyDate, { weekStartsOn: 1 }) +} |