atomic-fns
Version:
Like Lodash, but for ESNext and with types. Stop shipping code built for browsers from 2015.
66 lines (65 loc) • 2.05 kB
TypeScript
export declare type DateObject = {
year?: number;
month?: number;
day?: number;
weekday?: number;
hour?: number;
minute?: number;
second?: number;
millisecond?: number;
};
/**
* Returns the minimum (most distant past) of the given date values.
* @template T
* @param {Array<T>} dates
* @returns {T} The smallest date of `dates`
*/
export declare function minDate<T>(dates: Array<T>): T;
/**
* Returns the maximum (most distant future) of the given date values.
* @template T
* @param {Array<T>} dates
* @returns {T} The largest date of `dates`
*/
export declare function maxDate<T>(dates: Array<T>): T;
/**
* Returns `true` if the year is a leap year, otherwise `false`.
* @param year The date year
* @returns {boolean} `true` if is a leap year
*/
export declare function isLeapYear(year: number): boolean;
/**
* Get the number of days in the given year.
* @param year The date year
* @returns {number} Number of days in year
*/
export declare function daysInYear(year: number): number;
/**
* Get the number of days in the given date's month and year.
* @param date The specified date
* @returns {number} Number of days in month
*/
export declare function daysInMonth(date: string | number | Date): number;
export declare function asNumber(value: any): number;
export declare function parseISODuration(s: any): any;
/**
* Returns the number of weeks in the specified year.
* @param year
* @param firstDayOfWeek
* @param firstDayOfYear
*/
export declare function weeksInYear(year: number, firstDayOfWeek?: number, firstDayOfYear?: number): number;
/**
* Returns the week of the year for the specified date
* @param year
* @param dayOfYear
* @param firstDayOfWeek
* @param firstDayOfYear
* @returns
*/
export declare function weekOfYear(date: string | number | Date, firstDayOfWeek?: number, firstDayOfYear?: number): {
week: any;
year: any;
};
export declare function isoWeeksInYear(year: number): number;
export declare function dayOfYear(input: string | number | Date): number;