diff options
Diffstat (limited to 'date-fns/src/endOfMonth')
-rw-r--r-- | date-fns/src/endOfMonth/benchmark.js | 21 | ||||
-rw-r--r-- | date-fns/src/endOfMonth/index.d.ts | 4 | ||||
-rw-r--r-- | date-fns/src/endOfMonth/index.js.flow | 52 | ||||
-rw-r--r-- | date-fns/src/endOfMonth/index.ts | 34 | ||||
-rw-r--r-- | date-fns/src/endOfMonth/test.ts | 52 |
5 files changed, 163 insertions, 0 deletions
diff --git a/date-fns/src/endOfMonth/benchmark.js b/date-fns/src/endOfMonth/benchmark.js new file mode 100644 index 0000000..30791dd --- /dev/null +++ b/date-fns/src/endOfMonth/benchmark.js @@ -0,0 +1,21 @@ +// @flow +/* eslint-env mocha */ +/* global suite, benchmark */ + +import endOfMonth from '.' +import moment from 'moment' + +suite('endOfMonth', function () { + benchmark('date-fns', function () { + return endOfMonth(this.date) + }) + + benchmark('Moment.js', function () { + return this.moment.endOf('month') + }) +}, { + setup: function () { + this.date = new Date() + this.moment = moment() + } +}) diff --git a/date-fns/src/endOfMonth/index.d.ts b/date-fns/src/endOfMonth/index.d.ts new file mode 100644 index 0000000..59e7354 --- /dev/null +++ b/date-fns/src/endOfMonth/index.d.ts @@ -0,0 +1,4 @@ +// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it. + +import { endOfMonth } from 'date-fns' +export default endOfMonth diff --git a/date-fns/src/endOfMonth/index.js.flow b/date-fns/src/endOfMonth/index.js.flow new file mode 100644 index 0000000..4b7c616 --- /dev/null +++ b/date-fns/src/endOfMonth/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) => Date diff --git a/date-fns/src/endOfMonth/index.ts b/date-fns/src/endOfMonth/index.ts new file mode 100644 index 0000000..e5b8f9c --- /dev/null +++ b/date-fns/src/endOfMonth/index.ts @@ -0,0 +1,34 @@ +import toDate from '../toDate/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name endOfMonth + * @category Month Helpers + * @summary Return the end of a month for the given date. + * + * @description + * Return the end of a month for the given date. + * The result will be in the local timezone. + * + * ### 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 end of a month + * @throws {TypeError} 1 argument required + * + * @example + * // The end of a month for 2 September 2014 11:55:00: + * const result = endOfMonth(new Date(2014, 8, 2, 11, 55, 0)) + * //=> Tue Sep 30 2014 23:59:59.999 + */ +export default function endOfMonth(dirtyDate: Date | number): Date { + requiredArgs(1, arguments) + + const date = toDate(dirtyDate) + const month = date.getMonth() + date.setFullYear(date.getFullYear(), month + 1, 0) + date.setHours(23, 59, 59, 999) + return date +} diff --git a/date-fns/src/endOfMonth/test.ts b/date-fns/src/endOfMonth/test.ts new file mode 100644 index 0000000..bdc8494 --- /dev/null +++ b/date-fns/src/endOfMonth/test.ts @@ -0,0 +1,52 @@ +// @flow +/* eslint-env mocha */ + +import assert from 'power-assert' +import endOfMonth from '.' + +describe('endOfMonth', function() { + it('returns the date with the time set to 23:59:59.999 and the date set to the last day of a month', function() { + const date = new Date(2014, 8 /* Sep */, 2, 11, 55, 0) + const result = endOfMonth(date) + assert.deepEqual(result, new Date(2014, 8 /* Sep */, 30, 23, 59, 59, 999)) + }) + + it('accepts a timestamp', function() { + const date = new Date(2014, 8 /* Sep */, 2, 11, 55, 0).getTime() + const result = endOfMonth(date) + assert.deepEqual(result, new Date(2014, 8 /* Sep */, 30, 23, 59, 59, 999)) + }) + + it('does not mutate the original date', function() { + const date = new Date(2014, 8 /* Sep */, 2, 11, 55, 0) + endOfMonth(date) + assert.deepEqual(date, new Date(2014, 8 /* Sep */, 2, 11, 55, 0)) + }) + + describe('edge cases', function() { + it('works for last month in year', function() { + const date = new Date(2014, 11 /* Dec */, 1, 0, 0, 0) + const result = endOfMonth(date) + assert.deepEqual( + result, + new Date(2014, 11 /* Dec */, 31, 23, 59, 59, 999) + ) + }) + + it('works for last day of month', function() { + const date = new Date(2014, 9 /* Oct */, 31) + const result = endOfMonth(date) + assert.deepEqual(result, new Date(2014, 9 /* Oct */, 31, 23, 59, 59, 999)) + }) + }) + + it('returns `Invalid Date` if the given date is invalid', function() { + const result = endOfMonth(new Date(NaN)) + //@ts-expect-error + assert(result instanceof Date && isNaN(result)) + }) + + it('throws TypeError exception if passed less than 1 argument', function() { + assert.throws(endOfMonth.bind(null), TypeError) + }) +}) |