diff options
Diffstat (limited to 'date-fns/src/setQuarter')
-rw-r--r-- | date-fns/src/setQuarter/benchmark.js | 21 | ||||
-rw-r--r-- | date-fns/src/setQuarter/index.d.ts | 4 | ||||
-rw-r--r-- | date-fns/src/setQuarter/index.js.flow | 52 | ||||
-rw-r--r-- | date-fns/src/setQuarter/index.ts | 36 | ||||
-rw-r--r-- | date-fns/src/setQuarter/test.ts | 65 |
5 files changed, 178 insertions, 0 deletions
diff --git a/date-fns/src/setQuarter/benchmark.js b/date-fns/src/setQuarter/benchmark.js new file mode 100644 index 0000000..695a480 --- /dev/null +++ b/date-fns/src/setQuarter/benchmark.js @@ -0,0 +1,21 @@ +// @flow +/* eslint-env mocha */ +/* global suite, benchmark */ + +import setQuarter from '.' +import moment from 'moment' + +suite('setQuarter', function () { + benchmark('date-fns', function () { + return setQuarter(this.date, 3) + }) + + benchmark('Moment.js', function () { + return this.moment.quarter(3) + }) +}, { + setup: function () { + this.date = new Date() + this.moment = moment() + } +}) diff --git a/date-fns/src/setQuarter/index.d.ts b/date-fns/src/setQuarter/index.d.ts new file mode 100644 index 0000000..7e98fc9 --- /dev/null +++ b/date-fns/src/setQuarter/index.d.ts @@ -0,0 +1,4 @@ +// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it. + +import { setQuarter } from 'date-fns' +export default setQuarter diff --git a/date-fns/src/setQuarter/index.js.flow b/date-fns/src/setQuarter/index.js.flow new file mode 100644 index 0000000..d0e4d51 --- /dev/null +++ b/date-fns/src/setQuarter/index.js.flow @@ -0,0 +1,52 @@ +// @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, quarter: number) => Date diff --git a/date-fns/src/setQuarter/index.ts b/date-fns/src/setQuarter/index.ts new file mode 100644 index 0000000..3fb765d --- /dev/null +++ b/date-fns/src/setQuarter/index.ts @@ -0,0 +1,36 @@ +import toInteger from '../_lib/toInteger/index' +import toDate from '../toDate/index' +import setMonth from '../setMonth/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name setQuarter + * @category Quarter Helpers + * @summary Set the year quarter to the given date. + * + * @description + * Set the year quarter to the given 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 date to be changed + * @param {Number} quarter - the quarter of the new date + * @returns {Date} the new date with the quarter set + * @throws {TypeError} 2 arguments required + * + * @example + * // Set the 2nd quarter to 2 July 2014: + * const result = setQuarter(new Date(2014, 6, 2), 2) + * //=> Wed Apr 02 2014 00:00:00 + */ +export default function setQuarter(dirtyDate: Date | number, dirtyQuarter: number): Date { + requiredArgs(2, arguments) + + const date = toDate(dirtyDate) + const quarter = toInteger(dirtyQuarter) + const oldQuarter = Math.floor(date.getMonth() / 3) + 1 + const diff = quarter - oldQuarter + return setMonth(date, date.getMonth() + diff * 3) +} diff --git a/date-fns/src/setQuarter/test.ts b/date-fns/src/setQuarter/test.ts new file mode 100644 index 0000000..dc47195 --- /dev/null +++ b/date-fns/src/setQuarter/test.ts @@ -0,0 +1,65 @@ +// @flow +/* eslint-env mocha */ + +import assert from 'power-assert' +import setQuarter from '.' + +describe('setQuarter', function() { + it('sets the quarter of the year', function() { + const result = setQuarter(new Date(2014, 6 /* Jul */, 2), 1) + assert.deepEqual(result, new Date(2014, 0 /* Jan */, 2)) + }) + + it('sets the last day of the month if the original date was the last day of a longer month', function() { + const result = setQuarter(new Date(2014, 10 /* Nov */, 30), 1) + assert.deepEqual(result, new Date(2014, 1 /* Feb */, 28)) + }) + + it('accepts a timestamp', function() { + const result = setQuarter(new Date(2014, 6 /* Jul */, 1).getTime(), 4) + assert.deepEqual(result, new Date(2014, 9 /* Oct */, 1)) + }) + + it('converts a fractional number to an integer', function() { + const result = setQuarter(new Date(2014, 6 /* Jul */, 2), 1.951) + assert.deepEqual(result, new Date(2014, 0 /* Jan */, 2)) + }) + + it('implicitly converts number arguments', function() { + // @ts-expect-error + const result = setQuarter(new Date(2014, 6 /* Jul */, 2), '1') + assert.deepEqual(result, new Date(2014, 0 /* Jan */, 2)) + }) + + it('does not mutate the original date', function() { + const date = new Date(2014, 6 /* Jul */, 1) + setQuarter(date, 2) + assert.deepEqual(date, new Date(2014, 6 /* Jul */, 1)) + }) + + it('handles dates before 100 AD', function() { + const initialDate = new Date(0) + initialDate.setFullYear(0, 10 /* Nov */, 30) + initialDate.setHours(0, 0, 0, 0) + const expectedResult = new Date(0) + expectedResult.setFullYear(0, 1 /* Feb */, 29) + expectedResult.setHours(0, 0, 0, 0) + const result = setQuarter(initialDate, 1) + assert.deepEqual(result, expectedResult) + }) + + it('returns `Invalid Date` if the given date is invalid', function() { + const result = setQuarter(new Date(NaN), 1) + assert(result instanceof Date && isNaN(result.getTime())) + }) + + it('returns `Invalid Date` if the given amount is NaN', function() { + const result = setQuarter(new Date(2014, 6 /* Jul */, 2), NaN) + assert(result instanceof Date && isNaN(result.getTime())) + }) + + it('throws TypeError exception if passed less than 2 arguments', function() { + assert.throws(setQuarter.bind(null), TypeError) + assert.throws(setQuarter.bind(null, 1), TypeError) + }) +}) |