startOfYear.d.ts 763 B

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