summaryrefslogtreecommitdiff
path: root/date-fns/src/differenceInCalendarYears
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/differenceInCalendarYears')
-rw-r--r--date-fns/src/differenceInCalendarYears/benchmark.js16
-rw-r--r--date-fns/src/differenceInCalendarYears/index.d.ts4
-rw-r--r--date-fns/src/differenceInCalendarYears/index.js.flow55
-rw-r--r--date-fns/src/differenceInCalendarYears/index.ts39
-rw-r--r--date-fns/src/differenceInCalendarYears/test.ts105
5 files changed, 219 insertions, 0 deletions
diff --git a/date-fns/src/differenceInCalendarYears/benchmark.js b/date-fns/src/differenceInCalendarYears/benchmark.js
new file mode 100644
index 0000000..74f42ba
--- /dev/null
+++ b/date-fns/src/differenceInCalendarYears/benchmark.js
@@ -0,0 +1,16 @@
+// @flow
+/* eslint-env mocha */
+/* global suite, benchmark */
+
+import differenceInCalendarYears from '.'
+
+suite('differenceInCalendarYears', function () {
+ benchmark('date-fns', function () {
+ return differenceInCalendarYears(this.dateA, this.dateB)
+ })
+}, {
+ setup: function () {
+ this.dateA = new Date()
+ this.dateB = new Date(this.dateA.getTime() + 604800000)
+ }
+})
diff --git a/date-fns/src/differenceInCalendarYears/index.d.ts b/date-fns/src/differenceInCalendarYears/index.d.ts
new file mode 100644
index 0000000..3692b07
--- /dev/null
+++ b/date-fns/src/differenceInCalendarYears/index.d.ts
@@ -0,0 +1,4 @@
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+import { differenceInCalendarYears } from 'date-fns'
+export default differenceInCalendarYears
diff --git a/date-fns/src/differenceInCalendarYears/index.js.flow b/date-fns/src/differenceInCalendarYears/index.js.flow
new file mode 100644
index 0000000..c799819
--- /dev/null
+++ b/date-fns/src/differenceInCalendarYears/index.js.flow
@@ -0,0 +1,55 @@
+// @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: (
+ dateLeft: Date | number,
+ dateRight: Date | number
+) => number
diff --git a/date-fns/src/differenceInCalendarYears/index.ts b/date-fns/src/differenceInCalendarYears/index.ts
new file mode 100644
index 0000000..586b0fd
--- /dev/null
+++ b/date-fns/src/differenceInCalendarYears/index.ts
@@ -0,0 +1,39 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name differenceInCalendarYears
+ * @category Year Helpers
+ * @summary Get the number of calendar years between the given dates.
+ *
+ * @description
+ * Get the number of calendar years between the given dates.
+ *
+ * ### 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} dateLeft - the later date
+ * @param {Date|Number} dateRight - the earlier date
+ * @returns {Number} the number of calendar years
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // How many calendar years are between 31 December 2013 and 11 February 2015?
+ * const result = differenceInCalendarYears(
+ * new Date(2015, 1, 11),
+ * new Date(2013, 11, 31)
+ * )
+ * //=> 2
+ */
+export default function differenceInCalendarYears(
+ dirtyDateLeft: Date | number,
+ dirtyDateRight: Date | number
+): number {
+ requiredArgs(2, arguments)
+
+ const dateLeft = toDate(dirtyDateLeft)
+ const dateRight = toDate(dirtyDateRight)
+
+ return dateLeft.getFullYear() - dateRight.getFullYear()
+}
diff --git a/date-fns/src/differenceInCalendarYears/test.ts b/date-fns/src/differenceInCalendarYears/test.ts
new file mode 100644
index 0000000..7a27322
--- /dev/null
+++ b/date-fns/src/differenceInCalendarYears/test.ts
@@ -0,0 +1,105 @@
+// @flow
+/* eslint-env mocha */
+
+import assert from 'power-assert'
+import differenceInCalendarYears from '.'
+
+describe('differenceInCalendarYears', function () {
+ it('returns the number of calendar years between the given dates', function () {
+ const result = differenceInCalendarYears(
+ new Date(2012, 6 /* Jul */, 2, 18, 0),
+ new Date(2011, 6 /* Jul */, 2, 6, 0)
+ )
+ assert(result === 1)
+ })
+
+ it('returns a negative number if the time value of the first date is smaller', function () {
+ const result = differenceInCalendarYears(
+ new Date(2011, 6 /* Jul */, 2, 6, 0),
+ new Date(2012, 6 /* Jul */, 2, 18, 0)
+ )
+ assert(result === -1)
+ })
+
+ it('accepts timestamps', function () {
+ const result = differenceInCalendarYears(
+ new Date(2014, 6 /* Jul */, 2).getTime(),
+ new Date(2010, 6 /* Jul */, 2).getTime()
+ )
+ assert(result === 4)
+ })
+
+ describe('edge cases', function () {
+ it('the difference is less than a year, but the given dates are in different calendar years', function () {
+ const result = differenceInCalendarYears(
+ new Date(2015, 0 /* Jan */, 1),
+ new Date(2014, 11 /* Dec */, 31)
+ )
+ assert(result === 1)
+ })
+
+ it('the same for the swapped dates', function () {
+ const result = differenceInCalendarYears(
+ new Date(2014, 11 /* Dec */, 31),
+ new Date(2015, 0 /* Jan */, 1)
+ )
+ assert(result === -1)
+ })
+
+ it('the days and months of the given dates are the same', function () {
+ const result = differenceInCalendarYears(
+ new Date(2014, 8 /* Sep */, 5),
+ new Date(2012, 8 /* Sep */, 5)
+ )
+ assert(result === 2)
+ })
+
+ it('the given dates are the same', function () {
+ const result = differenceInCalendarYears(
+ new Date(2014, 8 /* Sep */, 5, 0, 0),
+ new Date(2014, 8 /* Sep */, 5, 0, 0)
+ )
+ assert(result === 0)
+ })
+
+ it('does not return -0 when the given dates are the same', () => {
+ function isNegativeZero(x: number): boolean {
+ return x === 0 && 1 / x < 0
+ }
+
+ const result = differenceInCalendarYears(
+ new Date(2014, 8 /* Sep */, 5, 0, 0),
+ new Date(2014, 8 /* Sep */, 5, 0, 0)
+ )
+
+ const resultIsNegative = isNegativeZero(result)
+ assert(resultIsNegative === false)
+ })
+ })
+
+ it('returns NaN if the first date is `Invalid Date`', function () {
+ const result = differenceInCalendarYears(
+ new Date(NaN),
+ new Date(2017, 0 /* Jan */, 1)
+ )
+ assert(isNaN(result))
+ })
+
+ it('returns NaN if the second date is `Invalid Date`', function () {
+ const result = differenceInCalendarYears(
+ new Date(2017, 0 /* Jan */, 1),
+ new Date(NaN)
+ )
+ assert(isNaN(result))
+ })
+
+ it('returns NaN if the both dates are `Invalid Date`', function () {
+ const result = differenceInCalendarYears(new Date(NaN), new Date(NaN))
+ assert(isNaN(result))
+ })
+
+ it('throws TypeError exception if passed less than 2 arguments', function () {
+ assert.throws(differenceInCalendarYears.bind(null), TypeError)
+ assert.throws(differenceInCalendarYears.bind(null, 1), TypeError)
+ })
+})