UNPKG

796 BTypeScriptView Raw
1/**
2 * @name startOfQuarter
3 * @category Quarter Helpers
4 * @summary Return the start of a year quarter for the given date.
5 *
6 * @description
7 * Return the start of a year quarter 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 start of a quarter
15 *
16 * @example
17 * // The start of a quarter for 2 September 2014 11:55:00:
18 * const result = startOfQuarter(new Date(2014, 8, 2, 11, 55, 0))
19 * //=> Tue Jul 01 2014 00:00:00
20 */
21export declare function startOfQuarter<DateType extends Date>(
22 date: DateType | number | string,
23): DateType;