lazy-kit-date v1.0.1

lazy-kit-date

A customized date toolkit.

Functions

/**
 * 根据输入的时间, 输出一个Date对象
 * @param input Date | number | string | number[]
 * @returns 
 */
function toDate(input: Date | number | string | number[]): Date;
/**
 * 日期格式化
 * @param input 日期对象、时间戳(数字|字符串)、数组([年,月,日,时,分,秒])
 * @param format 日期格式(yyyy-MM-dd hh:mm:ss.SSS), 默认yyyy-MM-dd hh:mm:ss.SSS
 * @returns 字符串
 */
function format(input: Date | number | string | number[], format?: string): string;

/**
 * 计算两个日期之间的差值
 * @param date1 日期
 * @param date2 日期
 * @param precision 精度单位 'h' | 'm' | 's' | 'ms', 默认ms
 * @returns 
 */
function diff(date1: Date, date2: Date, precision?: 'h' | 'm' | 's' | 'ms'): number;

/**
 * 计算偏移后的日期
 * @param inputDate 原日期
 * @param offsetValue 偏移量
 * @param offsetUnit 偏移单位 "ms"|"s"|"m"|"h"|"day"|"week"|"month", 默认ms
 * @returns 
 */
function offset(inputDate: Date, offsetValue: number, offsetUnit: "ms"|"s"|"m"|"h"|"day"|"week"|"month"): Date;

/**
 * 获取时间戳
 * @param milliseconds true, 默认[毫秒]级别, false时返回[秒]级别
 * @returns 
 */
function ts(milliseconds?: boolean): number;

/**
 * 睡眠等待
 * @param seconds 秒
 * @returns 
 */
function sleep(seconds: number): Promise<void>;