33 lines
987 B
JavaScript
33 lines
987 B
JavaScript
|
import toDate from '../toDate/index.js';
|
||
|
|
/**
|
||
|
|
* @name endOfDay
|
||
|
|
* @category Day Helpers
|
||
|
|
* @summary Return the end of a day for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the end of a day 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 day
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The end of a day for 2 September 2014 11:55:00:
|
||
|
|
* var result = endOfDay(new Date(2014, 8, 2, 11, 55, 0))
|
||
|
|
* //=> Tue Sep 02 2014 23:59:59.999
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function endOfDay(dirtyDate) {
|
||
|
|
if (arguments.length < 1) {
|
||
|
|
throw new TypeError('1 argument required, but only ' + arguments.length + ' present');
|
||
|
|
}
|
||
|
|
|
||
|
|
var date = toDate(dirtyDate);
|
||
|
|
date.setHours(23, 59, 59, 999);
|
||
|
|
return date;
|
||
|
|
}
|