startOfYear.cjs 1.1 KB

123456789101112131415161718192021222324252627282930313233343536
  1. "use strict";
  2. exports.startOfYear = startOfYear;
  3. var _index = require("./toDate.cjs");
  4. /**
  5. * The {@link startOfYear} function options.
  6. */
  7. /**
  8. * @name startOfYear
  9. * @category Year Helpers
  10. * @summary Return the start of a year for the given date.
  11. *
  12. * @description
  13. * Return the start of a year for the given date.
  14. * The result will be in the local timezone.
  15. *
  16. * @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).
  17. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  18. *
  19. * @param date - The original date
  20. * @param options - The options
  21. *
  22. * @returns The start of a year
  23. *
  24. * @example
  25. * // The start of a year for 2 September 2014 11:55:00:
  26. * const result = startOfYear(new Date(2014, 8, 2, 11, 55, 00))
  27. * //=> Wed Jan 01 2014 00:00:00
  28. */
  29. function startOfYear(date, options) {
  30. const date_ = (0, _index.toDate)(date, options?.in);
  31. date_.setFullYear(date_.getFullYear(), 0, 1);
  32. date_.setHours(0, 0, 0, 0);
  33. return date_;
  34. }