@stdlib/time/days-in-year/lib/main.js

Time utilities.

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var isDateObject = require( '@stdlib/assert/is-date-object' );
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var isLeapYear = require( '@stdlib/assert/is-leap-year' );
var format = require( '@stdlib/string/format' );
var currentYear = require( './../../current-year' );


// VARIABLES //

var NON_LEAP_YEAR = 365;
var LEAP_YEAR = 366;


// MAIN //

/**
* Returns the number of days in a year.
*
* @param {(integer|Date)} value - year or `Date` object
* @throws {TypeError} must provide either an integer or a `Date` object
* @returns {integer} number of days in a year
*
* @example
* var num = daysInYear();
* // returns <number>
*
* @example
* var num = daysInYear( 2016 );
* // returns 366
*
* @example
* var num = daysInYear( 2017 );
* // returns 365
*/
function daysInYear( value ) {
	var yr;
	if ( arguments.length ) {
		if ( isDateObject( value ) ) {
			yr = value.getFullYear();
		} else if ( isInteger( value ) ) {
			yr = value;
		} else {
			throw new TypeError( format( 'invalid argument. Must provide either an integer or a Date object. Value: `%s`.', value ) );
		}
	} else {
		// Note: cannot cache as application could cross over into a new year:
		yr = currentYear();
	}
	if ( isLeapYear( yr ) ) {
		return LEAP_YEAR;
	}
	return NON_LEAP_YEAR;
}


// EXPORTS //

module.exports = daysInYear;