33 lines
1.0 KiB
JavaScript
33 lines
1.0 KiB
JavaScript
import toDate from '../toDate/index.js';
|
|
/**
|
|
* @name startOfSecond
|
|
* @category Second Helpers
|
|
* @summary Return the start of a second for the given date.
|
|
*
|
|
* @description
|
|
* Return the start of a second 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 start of a second
|
|
* @throws {TypeError} 1 argument required
|
|
*
|
|
* @example
|
|
* // The start of a second for 1 December 2014 22:15:45.400:
|
|
* var result = startOfSecond(new Date(2014, 11, 1, 22, 15, 45, 400))
|
|
* //=> Mon Dec 01 2014 22:15:45.000
|
|
*/
|
|
|
|
export default function startOfSecond(dirtyDate) {
|
|
if (arguments.length < 1) {
|
|
throw new TypeError('1 argument required, but only ' + arguments.length + ' present');
|
|
}
|
|
|
|
var date = toDate(dirtyDate);
|
|
date.setMilliseconds(0);
|
|
return date;
|
|
} |