diff options
author | Sebastian <sebasjm@gmail.com> | 2021-08-23 16:46:06 -0300 |
---|---|---|
committer | Sebastian <sebasjm@gmail.com> | 2021-08-23 16:48:30 -0300 |
commit | 38acabfa6089ab8ac469c12b5f55022fb96935e5 (patch) | |
tree | 453dbf70000cc5e338b06201af1eaca8343f8f73 /date-fns/src/setWeek | |
parent | f26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff) | |
download | node-vendor-master.tar.gz node-vendor-master.tar.bz2 node-vendor-master.zip |
Diffstat (limited to 'date-fns/src/setWeek')
-rw-r--r-- | date-fns/src/setWeek/index.d.ts | 4 | ||||
-rw-r--r-- | date-fns/src/setWeek/index.js | 58 | ||||
-rw-r--r-- | date-fns/src/setWeek/index.js.flow | 60 | ||||
-rw-r--r-- | date-fns/src/setWeek/test.js | 100 |
4 files changed, 222 insertions, 0 deletions
diff --git a/date-fns/src/setWeek/index.d.ts b/date-fns/src/setWeek/index.d.ts new file mode 100644 index 0000000..b6c90f3 --- /dev/null +++ b/date-fns/src/setWeek/index.d.ts @@ -0,0 +1,4 @@ +// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it. + +import { setWeek } from 'date-fns' +export default setWeek diff --git a/date-fns/src/setWeek/index.js b/date-fns/src/setWeek/index.js new file mode 100644 index 0000000..568d088 --- /dev/null +++ b/date-fns/src/setWeek/index.js @@ -0,0 +1,58 @@ +import getWeek from '../getWeek/index' +import toDate from '../toDate/index' +import toInteger from '../_lib/toInteger/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name setWeek + * @category Week Helpers + * @summary Set the local week to the given date. + * + * @description + * Set the local week to the given date, saving the weekday number. + * The exact calculation depends on the values of + * `options.weekStartsOn` (which is the index of the first day of the week) + * and `options.firstWeekContainsDate` (which is the day of January, which is always in + * the first week of the week-numbering year) + * + * Week numbering: https://en.wikipedia.org/wiki/Week#Week_numbering + * + * ### 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 date to be changed + * @param {Number} week - the week of the new date + * @param {Object} [options] - an object with options. + * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale} + * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday) + * @param {1|2|3|4|5|6|7} [options.firstWeekContainsDate=1] - the day of January, which is always in the first week of the year + * @returns {Date} the new date with the local week set + * @throws {TypeError} 2 arguments required + * @throws {RangeError} `options.weekStartsOn` must be between 0 and 6 + * @throws {RangeError} `options.firstWeekContainsDate` must be between 1 and 7 + * + * @example + * // Set the 1st week to 2 January 2005 with default options: + * var result = setWeek(new Date(2005, 0, 2), 1) + * //=> Sun Dec 26 2004 00:00:00 + * + * @example + * // Set the 1st week to 2 January 2005, + * // if Monday is the first day of the week, + * // and the first week of the year always contains 4 January: + * var result = setWeek(new Date(2005, 0, 2), 1, { + * weekStartsOn: 1, + * firstWeekContainsDate: 4 + * }) + * //=> Sun Jan 4 2004 00:00:00 + */ +export default function setWeek(dirtyDate, dirtyWeek, dirtyOptions) { + requiredArgs(2, arguments) + + var date = toDate(dirtyDate) + var week = toInteger(dirtyWeek) + var diff = getWeek(date, dirtyOptions) - week + date.setDate(date.getDate() - diff * 7) + return date +} diff --git a/date-fns/src/setWeek/index.js.flow b/date-fns/src/setWeek/index.js.flow new file mode 100644 index 0000000..59b7eb3 --- /dev/null +++ b/date-fns/src/setWeek/index.js.flow @@ -0,0 +1,60 @@ +// @flow +// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it. + +export type Interval = { + start: Date | number, + end: Date | number, +} + +export type Locale = { + code?: string, + formatDistance?: (...args: Array<any>) => any, + formatRelative?: (...args: Array<any>) => any, + localize?: { + ordinalNumber: (...args: Array<any>) => any, + era: (...args: Array<any>) => any, + quarter: (...args: Array<any>) => any, + month: (...args: Array<any>) => any, + day: (...args: Array<any>) => any, + dayPeriod: (...args: Array<any>) => any, + }, + formatLong?: { + date: (...args: Array<any>) => any, + time: (...args: Array<any>) => any, + dateTime: (...args: Array<any>) => any, + }, + match?: { + ordinalNumber: (...args: Array<any>) => any, + era: (...args: Array<any>) => any, + quarter: (...args: Array<any>) => any, + month: (...args: Array<any>) => any, + day: (...args: Array<any>) => any, + dayPeriod: (...args: Array<any>) => any, + }, + options?: { + weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, + firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7, + }, +} + +export type Duration = { + years?: number, + months?: number, + weeks?: number, + days?: number, + hours?: number, + minutes?: number, + seconds?: number, +} + +export type Day = 0 | 1 | 2 | 3 | 4 | 5 | 6 + +declare module.exports: ( + date: Date | number, + week: number, + options?: { + locale?: Locale, + weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, + firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7, + } +) => Date diff --git a/date-fns/src/setWeek/test.js b/date-fns/src/setWeek/test.js new file mode 100644 index 0000000..dbf30d6 --- /dev/null +++ b/date-fns/src/setWeek/test.js @@ -0,0 +1,100 @@ +// @flow +/* eslint-env mocha */ + +import assert from 'power-assert' +import setWeek from '.' + +describe('setWeek', function() { + it('sets the local week', function() { + var result = setWeek(new Date(2005, 0 /* Jan */, 2), 1) + assert.deepEqual(result, new Date(2004, 11 /* Dec */, 26)) + }) + + it('accepts a timestamp', function() { + var result = setWeek(new Date(2009, 11 /* Dec */, 2).getTime(), 1) + assert.deepEqual(result, new Date(2008, 11 /* Dec */, 31)) + }) + + it('converts a fractional number to an integer', function() { + var result = setWeek(new Date(2005, 0 /* Jan */, 2), 1.9) + assert.deepEqual(result, new Date(2004, 11 /* Dec */, 26)) + }) + + it('implicitly converts number arguments', function() { + // $ExpectedMistake + var result = setWeek(new Date(2004, 7 /* Aug */, 7), '53') + assert.deepEqual(result, new Date(2005, 0 /* Jan */, 1)) + }) + + it('does not mutate the original date', function() { + var date = new Date(2014, 6 /* Jul */, 2) + setWeek(date, 52) + assert.deepEqual(date, new Date(2014, 6 /* Jul */, 2)) + }) + + it('handles dates before 100 AD', function() { + var initialDate = new Date(0) + initialDate.setFullYear(4, 0 /* Jan */, 4) + initialDate.setHours(0, 0, 0, 0) + var expectedResult = new Date(0) + expectedResult.setFullYear(4, 11 /* Dec */, 19) + expectedResult.setHours(0, 0, 0, 0) + var result = setWeek(initialDate, 52) + assert.deepEqual(result, expectedResult) + }) + + it('returns `Invalid Date` if the given date is invalid', function() { + var result = setWeek(new Date(NaN), 53) + assert(result instanceof Date && isNaN(result)) + }) + + it('returns `Invalid Date` if the given amount is NaN', function() { + var result = setWeek(new Date(2004, 7 /* Aug */, 7), NaN) + assert(result instanceof Date && isNaN(result)) + }) + + it('allows to specify `weekStartsOn` and `firstWeekContainsDate` in locale', function() { + var date = new Date(2005, 0 /* Jan */, 2) + var result = setWeek(date, 1, { + // $ExpectedMistake + locale: { + options: { weekStartsOn: 1, firstWeekContainsDate: 4 } + } + }) + assert.deepEqual(result, new Date(2004, 0 /* Jan */, 4)) + }) + + it('`options.weekStartsOn` overwrites the first day of the week specified in locale', function() { + var date = new Date(2005, 0 /* Jan */, 2) + var result = setWeek(date, 1, { + weekStartsOn: 1, + firstWeekContainsDate: 4, + // $ExpectedMistake + locale: { + options: { weekStartsOn: 0, firstWeekContainsDate: 1 } + } + }) + assert.deepEqual(result, new Date(2004, 0 /* Jan */, 4)) + }) + + it('throws `RangeError` if `options.weekStartsOn` is not convertable to 0, 1, ..., 6 or undefined', function() { + // $ExpectedMistake + var block = setWeek.bind(null, new Date(2004, 7 /* Aug */, 7), 53, { + weekStartsOn: NaN + }) + assert.throws(block, RangeError) + }) + + it('throws `RangeError` if `options.firstWeekContainsDate` is not convertable to 1, 2, ..., 7 or undefined', function() { + // $ExpectedMistake + var block = setWeek.bind(null, new Date(2004, 7 /* Aug */, 7), 53, { + firstWeekContainsDate: NaN + }) + assert.throws(block, RangeError) + }) + + it('throws TypeError exception if passed less than 2 arguments', function() { + assert.throws(setWeek.bind(null), TypeError) + assert.throws(setWeek.bind(null, 1), TypeError) + }) +}) |