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/differenceInCalendarQuarters/index.ts | |
parent | f26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff) | |
download | node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.gz node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.bz2 node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.zip |
Diffstat (limited to 'date-fns/src/differenceInCalendarQuarters/index.ts')
-rw-r--r-- | date-fns/src/differenceInCalendarQuarters/index.ts | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/date-fns/src/differenceInCalendarQuarters/index.ts b/date-fns/src/differenceInCalendarQuarters/index.ts new file mode 100644 index 0000000..d3569fd --- /dev/null +++ b/date-fns/src/differenceInCalendarQuarters/index.ts @@ -0,0 +1,43 @@ +import getQuarter from '../getQuarter/index' +import toDate from '../toDate/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name differenceInCalendarQuarters + * @category Quarter Helpers + * @summary Get the number of calendar quarters between the given dates. + * + * @description + * Get the number of calendar quarters 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 quarters + * @throws {TypeError} 2 arguments required + * + * @example + * // How many calendar quarters are between 31 December 2013 and 2 July 2014? + * var result = differenceInCalendarQuarters( + * new Date(2014, 6, 2), + * new Date(2013, 11, 31) + * ) + * //=> 3 + */ +export default function differenceInCalendarQuarters( + dirtyDateLeft: Date | number, + dirtyDateRight: Date | number +): number { + requiredArgs(2, arguments) + + const dateLeft = toDate(dirtyDateLeft) + const dateRight = toDate(dirtyDateRight) + + const yearDiff = dateLeft.getFullYear() - dateRight.getFullYear() + const quarterDiff = getQuarter(dateLeft) - getQuarter(dateRight) + + return yearDiff * 4 + quarterDiff +} |