zhytech-ui/dist/src/utils/dayjs.d.ts

基于Vue3 + ElementPlus + TypeScript封装的组件库

import { default as dayjs } from 'dayjs';
/**
 * 校检日期格式是否为YYYY-MM-DD这种格式
 * @param date
 * @returns {boolean}
 */
export declare function isValidDate(date: dayjs.ConfigType): boolean;
/**
 * 校检日期格式是否为YYYY-MM-DD HH:mm:ss这种格式
 * @param date
 * @returns {boolean}
 */
export declare function isValidDateTime(date: dayjs.ConfigType): boolean;
/**
 * 格式化日期年月日,时间格式为format，默认YYYY-MM-DD
 * @param date
 * @param format
 * @returns {string}
 */
export declare function formatDate(date: dayjs.ConfigType, format?: string): string;
/**
 * 获取当前日期年月日,时间格式为YYYY-MM-DD
 * @param format
 * @returns {string}
 */
export declare function getCurrentDate(format?: string): string;
/**
 * 获取当前日期年月日时分秒,时间格式为YYYY-MM-DD HH:mm:ss(24小时制,如果hh为小写表示为12小时制)
 * @param format
 * @returns {string}
 */
export declare function getCurrentDateTime(format?: string): string;
/**
 * 获取日期的毫秒数
 * @param date
 * @returns {string}
 */
export declare function getmilliseconds(date?: dayjs.ConfigType): number;
/**
 * 获取日期的指定值
 * @param date
 * @param dateType 为要获取日期类型,有如下类型:'minute','hour','day','month','year'这六种类型
 * @returns {string}
 */
export declare function getTimeByType(dateType: dayjs.ManipulateType, date?: dayjs.ConfigType): any;
/**
 * 将传过来的日期加X日期且时间格式为YYYY-MM-DD这种格式,如:getXAfterDate('2023-11-11',1,'day'),结果为2023-11-12
 * @param date:为传过来的日期
 * @param num:在当前日期加num,类型为int
 * @param dateType:为要加的日期类型,有如下类型:'minute','hour','day','week','month','year'这六种类型
 * @returns {string}
 */
export declare function getXAfterDate(date: dayjs.ConfigType, num: number, dateType: dayjs.ManipulateType): string;
/**
 * 将传过来的日期加X日期且时间格式为YYYY-MM-DD HH:mm:ss这种格式,如:getXAfterDateTime('2023-11-11 10:23:45',1,'day'),结果为2023-11-12 10:23:45
 * @param date:为传过来的日期
 * @param num:在当前日期加num,类型为int
 * @param dateType:为要加的日期类型,有如下类型:'minute','hour','day','week','month','year'这六种类型
 * @returns {string}
 */
export declare function getXAfterDateTime(date: dayjs.ConfigType, num: number, dateType: dayjs.ManipulateType): string;
/**
 * 将传过来的日期减去X日期且时间格式为YYYY-MM-DD这种格式,如:getXBeforeDate('2023-11-11',1,'day'),结果为2023-11-10
 * @param date:为传过来的日期
 * @param num:在当前日期加num,类型为int
 * @param dateType:为要加的日期类型,有如下类型:'minute','hour','day','week','month','year'这六种类型
 * @returns {string}
 */
export declare function getXBeforeDate(date: dayjs.ConfigType, num: number, dateType: dayjs.ManipulateType): string;
/**
 * 将传过来的日期减去X日期且时间格式为YYYY-MM-DD HH:mm:ss这种格式,如:getXBeforeDateTime('2023-11-11 10:23:45',1,'day'),结果为2023-11-10 10:23:45
 * @param date:为传过来的日期
 * @param num:在当前日期加day,类型为int
 * @param dateType:为要加的日期类型,有如下类型:'minute','hour','day','week','month','year'这六种类型
 * @returns {string}
 */
export declare function getXBeforeDateTime(date: dayjs.ConfigType, num: number, dateType: dayjs.ManipulateType): string;
/**
 * 计算2个日期之间的差值
 * @param startDate:开始日期
 * @param endDate:结束日期,结束日期要比开始日期大
 * @param dateType:日期类型,有如下类型:'minute','hour','day','week','month','year'这六种类型
 * @returns {number}
 */
export declare function getDateDiff(startDate: dayjs.ConfigType, endDate: dayjs.ConfigType, dateType: dayjs.ManipulateType): number;
/**
 * 判断date1是否在date2之前,比如:date1:2023-01-01 13:30:23,date2:2022-12-01 13:30:23,结果为false
 * @param date1
 * @param date2
 * @returns {boolean}
 */
export declare function isBefore(date1: dayjs.ConfigType, date2: dayjs.ConfigType): boolean;
/**
 * 判断date1是否在date2之后,比如:date1:2023-01-01 13:30:23,date2:2022-12-01 13:30:23,结果为true
 * @param date1
 * @param date2
 * @returns {boolean}
 */
export declare function isAfter(date1: dayjs.ConfigType, date2: dayjs.ConfigType): boolean;
/**
 * 判断date1是否与date2相同,比如:date1:2023-01-01 13:30:23,date2:2022-12-01 13:30:23,结果为false
 * @param date1
 * @param date2
 * @returns {boolean}
 */
export declare function isSame(date1: dayjs.ConfigType, date2: dayjs.ConfigType): boolean;
/**
 * 将传过来的日期转为当年的1月1号或者当月的1号或者当周的周一
 * @param date:传过来日期
 * @param dateType,日期类型,为:year,month,week这3种
 * @returns {string}
 */
export declare function getEarlyDaysDate(date: dayjs.ConfigType, dateType: dayjs.ManipulateType): string;
/**
 * 将传过来的日期转为当年的12月31号或者当月的最后一天或者当周的周日
 * @param date:传过来日期
 * @param dateType,日期类型,为:year,month,week这3种
 * @returns {string}
 */
export declare function getLastDaysDate(date: dayjs.ConfigType, dateType: dayjs.ManipulateType): string;
/**
 * 获取2个日期之间的所有日期,包括开始日期和结束日期,如:getIntermediateDate('2023-12-01','2023-12-15',1,'day'))
 * @param startDate:开始日期
 * @param endDate:结束日期要大于开始日期
 * @param num:在开始日期上加num,int类型,如果dateType为day,num为1那么就是在开始日期上加一天
 * @param dateType,日期类型,类型如下:'minute','hour','day','week','month','year'这六种类型
 * @returns {*[]}
 */
export declare function getIntermediateDate(startDate: dayjs.ConfigType, endDate: dayjs.ConfigType, num: number, dateType: dayjs.ManipulateType): (string | number | Date | dayjs.Dayjs | null | undefined)[];