when-off/es/index.d.ts

一个用于处理日期、日历、节假日和工作日的 TypeScript 工具库, 并且提供各个国家法定节假日和调休安排信息数据

declare enum RegionEnum {
    /** 中国 */
    CN = "CN"
}

declare class WhenOff {
    private currentRegion;
    private currentYear;
    constructor(region?: RegionEnum, year?: number);
    private formatDateString;
    /**
     * @description 判断指定日期是否为节假日
     */
    isHoliday(date: Date, region?: 'CN'): boolean | undefined;
    /**
     * @description 判断指定日期是否为工作日
     */
    isWorkingDay(date: Date): boolean | undefined;
    /**
     * @description 判断指定日期是否为补班日
     */
    isAlternateWorkDay(date: Date, region?: string): boolean | undefined;
    /**
     * @description 获取指定日期节假日相关信息
     */
    getDateInfo(date: Date, region?: 'CN'): {
        date: string;
        name: string;
        name_cn: string;
        name_en: string;
        type: string;
    } | undefined;
    /**
     * @description 获取节假日统计信息
     */
    getHolidayStats(region?: 'CN'): {
        totalHolidays: number;
        totalAlternateWorkdays: number;
    } | undefined;
}

export { WhenOff as default };