@cloudcome/utils-core/dist/date/is.d.ts

cloudcome core utils

import { DateValue } from './core';
/**
 * 判断给定的年份是否为闰年
 * @param year - 需要判断的年份
 * @returns 如果年份是闰年则返回 true，否则返回 false
 * @example
 * ```typescript
 * isLeapYear(2020); // true
 * isLeapYear(2021); // false
 * isLeapYear(2000); // true
 * isLeapYear(1900); // false
 * ```
 */
export declare function isLeapYear(year: number): boolean;
/**
 * 比较两个日期的年份是否相同
 * @param date1 - 第一个日期，可以是数值、字符串或 Date 对象
 * @param date2 - 第二个日期，可以是数值、字符串或 Date 对象
 * @returns 如果两个日期的年份相同则返回 true，否则返回 false
 * @example
 * ```typescript
 * const date1 = new Date(2023, 5, 15);
 * const date2 = new Date(2023, 6, 20);
 * isSameDateInYear(date1, date2); // true
 * ```
 */
export declare function isSameDateInYear(date1: DateValue, date2: DateValue): boolean;
/**
 * 比较两个日期的年份和月份是否相同
 * @param date1 - 第一个日期，可以是数值、字符串或 Date 对象
 * @param date2 - 第二个日期，可以是数值、字符串或 Date 对象
 * @returns 如果两个日期的年份和月份相同则返回 true，否则返回 false
 * @example
 * ```typescript
 * const date1 = new Date(2023, 5, 15);
 * const date2 = new Date(2023, 5, 20);
 * isSameDateInMonth(date1, date2); // true
 * ```
 */
export declare function isSameDateInMonth(date1: DateValue, date2: DateValue): boolean;
/**
 * 比较两个日期的年份、月份和天数是否相同
 * @param date1 - 第一个日期，可以是数值、字符串或 Date 对象
 * @param date2 - 第二个日期，可以是数值、字符串或 Date 对象
 * @returns 如果两个日期的年份、月份和天数相同则返回 true，否则返回 false
 * @example
 * ```typescript
 * const date1 = new Date(2023, 5, 15);
 * const date2 = new Date(2023, 5, 15);
 * isSameDateInDay(date1, date2); // true
 * ```
 */
export declare function isSameDateInDay(date1: DateValue, date2: DateValue): boolean;
/**
 * 比较两个日期的年份、月份、天数和小时是否相同
 * @param date1 - 第一个日期，可以是数值、字符串或 Date 对象
 * @param date2 - 第二个日期，可以是数值、字符串或 Date 对象
 * @returns 如果两个日期的年份、月份、天数和小时相同则返回 true，否则返回 false
 * @example
 * ```typescript
 * const date1 = new Date(2023, 5, 15, 12);
 * const date2 = new Date(2023, 5, 15, 12);
 * isSameDateInHour(date1, date2); // true
 * ```
 */
export declare function isSameDateInHour(date1: DateValue, date2: DateValue): boolean;
/**
 * 比较两个日期的年份、月份、天数、小时和分钟是否相同
 * @param date1 - 第一个日期，可以是数值、字符串或 Date 对象
 * @param date2 - 第二个日期，可以是数值、字符串或 Date 对象
 * @returns 如果两个日期的年份、月份、天数、小时和分钟相同则返回 true，否则返回 false
 * @example
 * ```typescript
 * const date1 = new Date(2023, 5, 15, 12, 30);
 * const date2 = new Date(2023, 5, 15, 12, 30);
 * isSameDateInMinute(date1, date2); // true
 * ```
 */
export declare function isSameDateInMinute(date1: DateValue, date2: DateValue): boolean;
/**
 * 比较两个日期的年份、月份、天数、小时、分钟和秒数是否相同
 * @param date1 - 第一个日期，可以是数值、字符串或 Date 对象
 * @param date2 - 第二个日期，可以是数值、字符串或 Date 对象
 * @returns 如果两个日期的年份、月份、天数、小时、分钟和秒数相同则返回 true，否则返回 false
 * @example
 * ```typescript
 * const date1 = new Date(2023, 5, 15, 12, 30, 45);
 * const date2 = new Date(2023, 5, 15, 12, 30, 45);
 * isSameDateInSecond(date1, date2); // true
 * ```
 */
export declare function isSameDateInSecond(date1: DateValue, date2: DateValue): boolean;