timepiece/node_modules/date-fns/endOfSecond.mjs

31 lines
889 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { toDate } from "./toDate.mjs";
/**
* @name endOfSecond
* @category Second Helpers
* @summary Return the end of a second for the given date.
*
* @description
* Return the end of a second for the given date.
* The result will be in the local timezone.
*
* @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 date - The original date
*
* @returns The end of a second
*
* @example
* // The end of a second for 1 December 2014 22:15:45.400:
* const result = endOfSecond(new Date(2014, 11, 1, 22, 15, 45, 400))
* //=> Mon Dec 01 2014 22:15:45.999
*/
export function endOfSecond(date) {
const _date = toDate(date);
_date.setMilliseconds(999);
return _date;
}
// Fallback for modularized imports:
export default endOfSecond;