summaryrefslogtreecommitdiff
path: root/date-fns/src/startOfWeekYear
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-08-23 16:46:06 -0300
committerSebastian <sebasjm@gmail.com>2021-08-23 16:48:30 -0300
commit38acabfa6089ab8ac469c12b5f55022fb96935e5 (patch)
tree453dbf70000cc5e338b06201af1eaca8343f8f73 /date-fns/src/startOfWeekYear
parentf26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff)
downloadnode-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.gz
node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.bz2
node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.zip
added web vendorsHEADmaster
Diffstat (limited to 'date-fns/src/startOfWeekYear')
-rw-r--r--date-fns/src/startOfWeekYear/index.d.ts4
-rw-r--r--date-fns/src/startOfWeekYear/index.js71
-rw-r--r--date-fns/src/startOfWeekYear/index.js.flow59
-rw-r--r--date-fns/src/startOfWeekYear/test.js83
4 files changed, 217 insertions, 0 deletions
diff --git a/date-fns/src/startOfWeekYear/index.d.ts b/date-fns/src/startOfWeekYear/index.d.ts
new file mode 100644
index 0000000..95b4851
--- /dev/null
+++ b/date-fns/src/startOfWeekYear/index.d.ts
@@ -0,0 +1,4 @@
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+import { startOfWeekYear } from 'date-fns'
+export default startOfWeekYear
diff --git a/date-fns/src/startOfWeekYear/index.js b/date-fns/src/startOfWeekYear/index.js
new file mode 100644
index 0000000..a35fdde
--- /dev/null
+++ b/date-fns/src/startOfWeekYear/index.js
@@ -0,0 +1,71 @@
+import getWeekYear from '../getWeekYear/index'
+import startOfWeek from '../startOfWeek/index'
+import toInteger from '../_lib/toInteger/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name startOfWeekYear
+ * @category Week-Numbering Year Helpers
+ * @summary Return the start of a local week-numbering year for the given date.
+ *
+ * @description
+ * Return the start of a local week-numbering year.
+ * 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 original 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 start of a week-numbering year
+ * @throws {TypeError} 1 argument required
+ * @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
+ * @throws {RangeError} `options.firstWeekContainsDate` must be between 1 and 7
+ *
+ * @example
+ * // The start of an a week-numbering year for 2 July 2005 with default settings:
+ * var result = startOfWeekYear(new Date(2005, 6, 2))
+ * //=> Sun Dec 26 2004 00:00:00
+ *
+ * @example
+ * // The start of a week-numbering year for 2 July 2005
+ * // if Monday is the first day of week
+ * // and 4 January is always in the first week of the year:
+ * var result = startOfWeekYear(new Date(2005, 6, 2), {
+ * weekStartsOn: 1,
+ * firstWeekContainsDate: 4
+ * })
+ * //=> Mon Jan 03 2005 00:00:00
+ */
+export default function startOfWeekYear(dirtyDate, dirtyOptions) {
+ requiredArgs(1, arguments)
+
+ var options = dirtyOptions || {}
+ var locale = options.locale
+ var localeFirstWeekContainsDate =
+ locale && locale.options && locale.options.firstWeekContainsDate
+ var defaultFirstWeekContainsDate =
+ localeFirstWeekContainsDate == null
+ ? 1
+ : toInteger(localeFirstWeekContainsDate)
+ var firstWeekContainsDate =
+ options.firstWeekContainsDate == null
+ ? defaultFirstWeekContainsDate
+ : toInteger(options.firstWeekContainsDate)
+
+ var year = getWeekYear(dirtyDate, dirtyOptions)
+ var firstWeek = new Date(0)
+ firstWeek.setFullYear(year, 0, firstWeekContainsDate)
+ firstWeek.setHours(0, 0, 0, 0)
+ var date = startOfWeek(firstWeek, dirtyOptions)
+ return date
+}
diff --git a/date-fns/src/startOfWeekYear/index.js.flow b/date-fns/src/startOfWeekYear/index.js.flow
new file mode 100644
index 0000000..49cecb6
--- /dev/null
+++ b/date-fns/src/startOfWeekYear/index.js.flow
@@ -0,0 +1,59 @@
+// @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,
+ 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/startOfWeekYear/test.js b/date-fns/src/startOfWeekYear/test.js
new file mode 100644
index 0000000..c01bfa7
--- /dev/null
+++ b/date-fns/src/startOfWeekYear/test.js
@@ -0,0 +1,83 @@
+// @flow
+/* eslint-env mocha */
+
+import assert from 'power-assert'
+import startOfWeekYear from '.'
+
+describe('startOfWeekYear', function() {
+ it('returns the date with the time set to 00:00:00 and the date set to the first day of a week year', function() {
+ var result = startOfWeekYear(new Date(2005, 6 /* Jul */, 2))
+ assert.deepEqual(result, new Date(2004, 11 /* Dec */, 26, 0, 0, 0, 0))
+ })
+
+ it('accepts a timestamp', function() {
+ var result = startOfWeekYear(new Date(2005, 0 /* Jan */, 1, 6, 0).getTime())
+ assert.deepEqual(result, new Date(2004, 11 /* Dec */, 26, 0, 0, 0, 0))
+ })
+
+ it('does not mutate the original date', function() {
+ var date = new Date(2014, 6 /* Jul */, 2)
+ startOfWeekYear(date)
+ assert.deepEqual(date, new Date(2014, 6 /* Jul */, 2))
+ })
+
+ it('handles dates before 100 AD', function() {
+ var initialDate = new Date(0)
+ initialDate.setFullYear(9, 0 /* Jan */, 1)
+ initialDate.setHours(0, 0, 0, 0)
+ var expectedResult = new Date(0)
+ expectedResult.setFullYear(8, 11 /* Dec */, 28)
+ expectedResult.setHours(0, 0, 0, 0)
+ var result = startOfWeekYear(initialDate)
+ assert.deepEqual(result, expectedResult)
+ })
+
+ it('returns `Invalid Date` if the given date is invalid', function() {
+ var result = startOfWeekYear(new Date(NaN))
+ assert(result instanceof Date && isNaN(result))
+ })
+
+ it('allows to specify `weekStartsOn` and `firstWeekContainsDate` in locale', function() {
+ var date = new Date(2005, 6 /* Jul */, 2)
+ var result = startOfWeekYear(date, {
+ // $ExpectedMistake
+ locale: {
+ options: { weekStartsOn: 1, firstWeekContainsDate: 4 }
+ }
+ })
+ assert.deepEqual(result, new Date(2005, 0 /* Jan */, 3, 0, 0, 0, 0))
+ })
+
+ it('`options.weekStartsOn` overwrites the first day of the week specified in locale', function() {
+ var date = new Date(2005, 6 /* Jul */, 2)
+ var result = startOfWeekYear(date, {
+ weekStartsOn: 1,
+ firstWeekContainsDate: 4,
+ // $ExpectedMistake
+ locale: {
+ options: { weekStartsOn: 0, firstWeekContainsDate: 1 }
+ }
+ })
+ assert.deepEqual(result, new Date(2005, 0 /* Jan */, 3, 0, 0, 0, 0))
+ })
+
+ it('throws `RangeError` if `options.weekStartsOn` is not convertable to 0, 1, ..., 6 or undefined', function() {
+ // $ExpectedMistake
+ var block = startOfWeekYear.bind(null, new Date(2007, 11 /* Dec */, 31), {
+ 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 = startOfWeekYear.bind(null, new Date(2007, 11 /* Dec */, 31), {
+ firstWeekContainsDate: NaN
+ })
+ assert.throws(block, RangeError)
+ })
+
+ it('throws TypeError exception if passed less than 1 argument', function() {
+ assert.throws(startOfWeekYear.bind(null), TypeError)
+ })
+})