UNPKG

778 BTypeScriptView Raw
1/**
2 * @name endOfMinute
3 * @category Minute Helpers
4 * @summary Return the end of a minute for the given date.
5 *
6 * @description
7 * Return the end of a minute for the given date.
8 * The result will be in the local timezone.
9 *
10 * @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).
11 *
12 * @param date - The original date
13 *
14 * @returns The end of a minute
15 *
16 * @example
17 * // The end of a minute for 1 December 2014 22:15:45.400:
18 * const result = endOfMinute(new Date(2014, 11, 1, 22, 15, 45, 400))
19 * //=> Mon Dec 01 2014 22:15:59.999
20 */
21export declare function endOfMinute<DateType extends Date>(
22 date: DateType | number | string,
23): DateType;