36 lines
1.1 KiB
JavaScript
36 lines
1.1 KiB
JavaScript
|
"use strict";
|
||
|
|
exports.startOfSecond = startOfSecond;
|
||
|
|
var _index = require("./toDate.cjs");
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link startOfSecond} function options.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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.
|
||
|
|
*
|
||
|
|
* @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).
|
||
|
|
* @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
||
|
|
*
|
||
|
|
* @param date - The original date
|
||
|
|
* @param options - The options
|
||
|
|
*
|
||
|
|
* @returns The start of a second
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The start of a second for 1 December 2014 22:15:45.400:
|
||
|
|
* const result = startOfSecond(new Date(2014, 11, 1, 22, 15, 45, 400))
|
||
|
|
* //=> Mon Dec 01 2014 22:15:45.000
|
||
|
|
*/
|
||
|
|
function startOfSecond(date, options) {
|
||
|
|
const date_ = (0, _index.toDate)(date, options?.in);
|
||
|
|
date_.setMilliseconds(0);
|
||
|
|
return date_;
|
||
|
|
}
|