diff options
Diffstat (limited to 'date-fns/src/startOfDay/index.ts')
-rw-r--r-- | date-fns/src/startOfDay/index.ts | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/date-fns/src/startOfDay/index.ts b/date-fns/src/startOfDay/index.ts new file mode 100644 index 0000000..0292c47 --- /dev/null +++ b/date-fns/src/startOfDay/index.ts @@ -0,0 +1,32 @@ +import toDate from '../toDate/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name startOfDay + * @category Day Helpers + * @summary Return the start of a day for the given date. + * + * @description + * Return the start of a day 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 day + * @throws {TypeError} 1 argument required + * + * @example + * // The start of a day for 2 September 2014 11:55:00: + * const result = startOfDay(new Date(2014, 8, 2, 11, 55, 0)) + * //=> Tue Sep 02 2014 00:00:00 + */ +export default function startOfDay(dirtyDate: Date | number): Date { + requiredArgs(1, arguments) + + const date = toDate(dirtyDate) + date.setHours(0, 0, 0, 0) + return date +} |