UNPKG

date-fns/startOfToday.d.ts

Version:

352 BTypeScriptView Raw

1/**
* @name startOfToday
* @category Day Helpers
* @summary Return the start of today.
* @pure false
*
* @description
* Return the start of today.
*
* @returns The start of today
*
* @example
* // If today is 6 October 2014:
* const result = startOfToday()
* //=> Mon Oct 6 2014 00:00:00
*/
17export declare function startOfToday(): Date;

1	`/**`
2	`* @name startOfToday`
3	`* @category Day Helpers`
4	`* @summary Return the start of today.`
5	`* @pure false`
6	`*`
7	`* @description`
8	`* Return the start of today.`
9	`*`
10	`* @returns The start of today`
11	`*`
12	`* @example`
13	`* // If today is 6 October 2014:`
14	`* const result = startOfToday()`
15	`* //=> Mon Oct 6 2014 00:00:00`
16	`*/`
17	`export declare function startOfToday(): Date;`