index.js 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = startOfDay;
  6. var _index = _interopRequireDefault(require("../toDate/index.js"));
  7. var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  8. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  9. /**
  10. * @name startOfDay
  11. * @category Day Helpers
  12. * @summary Return the start of a day for the given date.
  13. *
  14. * @description
  15. * Return the start of a day for the given date.
  16. * The result will be in the local timezone.
  17. *
  18. * ### v2.0.0 breaking changes:
  19. *
  20. * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
  21. *
  22. * @param {Date|Number} date - the original date
  23. * @returns {Date} the start of a day
  24. * @throws {TypeError} 1 argument required
  25. *
  26. * @example
  27. * // The start of a day for 2 September 2014 11:55:00:
  28. * const result = startOfDay(new Date(2014, 8, 2, 11, 55, 0))
  29. * //=> Tue Sep 02 2014 00:00:00
  30. */
  31. function startOfDay(dirtyDate) {
  32. (0, _index2.default)(1, arguments);
  33. var date = (0, _index.default)(dirtyDate);
  34. date.setHours(0, 0, 0, 0);
  35. return date;
  36. }
  37. module.exports = exports.default;