89 lines
2.8 KiB
JavaScript
89 lines
2.8 KiB
JavaScript
|
"use strict";
|
||
|
|
exports.differenceInBusinessDays = differenceInBusinessDays;
|
||
|
|
var _index = require("./addDays.js");
|
||
|
|
var _index2 = require("./differenceInCalendarDays.js");
|
||
|
|
var _index3 = require("./isSameDay.js");
|
||
|
|
var _index4 = require("./isValid.js");
|
||
|
|
var _index5 = require("./isWeekend.js");
|
||
|
|
var _index6 = require("./toDate.js");
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name differenceInBusinessDays
|
||
|
|
* @category Day Helpers
|
||
|
|
* @summary Get the number of business days between the given dates.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of business day periods between the given dates.
|
||
|
|
* Business days being days that arent in the weekend.
|
||
|
|
* Like `differenceInCalendarDays`, the function removes the times from
|
||
|
|
* the dates before calculating the difference.
|
||
|
|
*
|
||
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
||
|
|
*
|
||
|
|
* @param dateLeft - The later date
|
||
|
|
* @param dateRight - The earlier date
|
||
|
|
*
|
||
|
|
* @returns The number of business days
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many business days are between
|
||
|
|
* // 10 January 2014 and 20 July 2014?
|
||
|
|
* const result = differenceInBusinessDays(
|
||
|
|
* new Date(2014, 6, 20),
|
||
|
|
* new Date(2014, 0, 10)
|
||
|
|
* )
|
||
|
|
* //=> 136
|
||
|
|
*
|
||
|
|
* // How many business days are between
|
||
|
|
* // 30 November 2021 and 1 November 2021?
|
||
|
|
* const result = differenceInBusinessDays(
|
||
|
|
* new Date(2021, 10, 30),
|
||
|
|
* new Date(2021, 10, 1)
|
||
|
|
* )
|
||
|
|
* //=> 21
|
||
|
|
*
|
||
|
|
* // How many business days are between
|
||
|
|
* // 1 November 2021 and 1 December 2021?
|
||
|
|
* const result = differenceInBusinessDays(
|
||
|
|
* new Date(2021, 10, 1),
|
||
|
|
* new Date(2021, 11, 1)
|
||
|
|
* )
|
||
|
|
* //=> -22
|
||
|
|
*
|
||
|
|
* // How many business days are between
|
||
|
|
* // 1 November 2021 and 1 November 2021 ?
|
||
|
|
* const result = differenceInBusinessDays(
|
||
|
|
* new Date(2021, 10, 1),
|
||
|
|
* new Date(2021, 10, 1)
|
||
|
|
* )
|
||
|
|
* //=> 0
|
||
|
|
*/
|
||
|
|
function differenceInBusinessDays(dateLeft, dateRight) {
|
||
|
|
const _dateLeft = (0, _index6.toDate)(dateLeft);
|
||
|
|
let _dateRight = (0, _index6.toDate)(dateRight);
|
||
|
|
|
||
|
|
if (!(0, _index4.isValid)(_dateLeft) || !(0, _index4.isValid)(_dateRight))
|
||
|
|
return NaN;
|
||
|
|
|
||
|
|
const calendarDifference = (0, _index2.differenceInCalendarDays)(
|
||
|
|
_dateLeft,
|
||
|
|
_dateRight,
|
||
|
|
);
|
||
|
|
const sign = calendarDifference < 0 ? -1 : 1;
|
||
|
|
|
||
|
|
const weeks = Math.trunc(calendarDifference / 7);
|
||
|
|
|
||
|
|
let result = weeks * 5;
|
||
|
|
_dateRight = (0, _index.addDays)(_dateRight, weeks * 7);
|
||
|
|
|
||
|
|
// the loop below will run at most 6 times to account for the remaining days that don't makeup a full week
|
||
|
|
while (!(0, _index3.isSameDay)(_dateLeft, _dateRight)) {
|
||
|
|
// sign is used to account for both negative and positive differences
|
||
|
|
result += (0, _index5.isWeekend)(_dateRight) ? 0 : sign;
|
||
|
|
_dateRight = (0, _index.addDays)(_dateRight, sign);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Prevent negative zero
|
||
|
|
return result === 0 ? 0 : result;
|
||
|
|
}
|