32 lines
662 B
JavaScript
32 lines
662 B
JavaScript
"use strict";
|
|
exports.startOfToday = startOfToday;
|
|
var _index = require("./startOfDay.cjs");
|
|
|
|
/**
|
|
* The {@link startOfToday} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name startOfToday
|
|
* @category Day Helpers
|
|
* @summary Return the start of today.
|
|
* @pure false
|
|
*
|
|
* @description
|
|
* Return the start of today.
|
|
*
|
|
* @typeParam ContextDate - The `Date` type of the context function.
|
|
*
|
|
* @param options - An object with options
|
|
*
|
|
* @returns The start of today
|
|
*
|
|
* @example
|
|
* // If today is 6 October 2014:
|
|
* const result = startOfToday()
|
|
* //=> Mon Oct 6 2014 00:00:00
|
|
*/
|
|
function startOfToday(options) {
|
|
return (0, _index.startOfDay)(Date.now(), options);
|
|
}
|