diff options
Diffstat (limited to 'date-fns/src/getDaysInYear/index.ts')
-rw-r--r-- | date-fns/src/getDaysInYear/index.ts | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/date-fns/src/getDaysInYear/index.ts b/date-fns/src/getDaysInYear/index.ts new file mode 100644 index 0000000..c374a8f --- /dev/null +++ b/date-fns/src/getDaysInYear/index.ts @@ -0,0 +1,36 @@ +import toDate from '../toDate/index' +import isLeapYear from '../isLeapYear/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name getDaysInYear + * @category Year Helpers + * @summary Get the number of days in a year of the given date. + * + * @description + * Get the number of days in a year of the given date. + * + * ### 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 given date + * @returns {Number} the number of days in a year + * @throws {TypeError} 1 argument required + * + * @example + * // How many days are in 2012? + * const result = getDaysInYear(new Date(2012, 0, 1)) + * //=> 366 + */ +export default function getDaysInYear(dirtyDate: Date | number): number { + requiredArgs(1, arguments) + + const date = toDate(dirtyDate) + + if (String(new Date(date)) === 'Invalid Date') { + return NaN + } + + return isLeapYear(date) ? 366 : 365 +} |