@stdlib/time/iso-weeks-in-year/docs/types/index.d.ts

Time utilities.

/*
* @license Apache-2.0
*
* Copyright (c) 2019 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.
*/

// TypeScript Version: 4.1

/**
* Returns the number of ISO weeks in a year according to the Gregorian calendar.
*
* ## Notes
*
* -   By default, the function returns the number of ISO weeks in the current year (according to local time). To determine the number of ISO weeks for a particular year, provide either a year or a `Date` object.
*
* @param value - year or `Date` object
* @returns number of ISO weeks in a year
*
* @example
* var num = isoWeeksInYear();
* // returns <number>
*
* @example
* var num = isoWeeksInYear( 2015 );
* // returns 53
*
* @example
* var num = isoWeeksInYear( 2017 );
* // returns 52
*/
declare function isoWeeksInYear( value?: number | Date ): number;


// EXPORTS //

export = isoWeeksInYear;