46 lines
1.3 KiB
JavaScript
46 lines
1.3 KiB
JavaScript
|
"use strict";
|
||
|
|
||
|
Object.defineProperty(exports, "__esModule", {
|
||
|
value: true
|
||
|
});
|
||
|
exports.default = startOfYear;
|
||
|
|
||
|
var _index = _interopRequireDefault(require("../toDate/index.js"));
|
||
|
|
||
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
||
|
|
||
|
/**
|
||
|
* @name startOfYear
|
||
|
* @category Year Helpers
|
||
|
* @summary Return the start of a year for the given date.
|
||
|
*
|
||
|
* @description
|
||
|
* Return the start of a year for the given date.
|
||
|
* The result will be in the local timezone.
|
||
|
*
|
||
|
* ### v2.0.0 breaking changes:
|
||
|
*
|
||
|
* - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
|
||
|
*
|
||
|
* @param {Date|Number} date - the original date
|
||
|
* @returns {Date} the start of a year
|
||
|
* @throws {TypeError} 1 argument required
|
||
|
*
|
||
|
* @example
|
||
|
* // The start of a year for 2 September 2014 11:55:00:
|
||
|
* var result = startOfYear(new Date(2014, 8, 2, 11, 55, 00))
|
||
|
* //=> Wed Jan 01 2014 00:00:00
|
||
|
*/
|
||
|
function startOfYear(dirtyDate) {
|
||
|
if (arguments.length < 1) {
|
||
|
throw new TypeError('1 argument required, but only ' + arguments.length + ' present');
|
||
|
}
|
||
|
|
||
|
var cleanDate = (0, _index.default)(dirtyDate);
|
||
|
var date = new Date(0);
|
||
|
date.setFullYear(cleanDate.getFullYear(), 0, 1);
|
||
|
date.setHours(0, 0, 0, 0);
|
||
|
return date;
|
||
|
}
|
||
|
|
||
|
module.exports = exports.default;
|