typescript-util/esm/constant/TimeUnit.d.ts

JS/TS 的简单工具

import { PureCallback } from '../Function';
/**
 * 时间单位 <br>
 * 提供更可读的计时操作 <br>
 * 例:
 * <pre>
 *     // 3 秒后执行
 *     const timer = TimeUnit.SECOND.setTimeout(() => {
 *         // ......
 *     }, 3)
 *
 *     // 设置过期时间: 一周
 *     const expirationTime = TimeUnit.WEEK.toMillis()
 * </pre>
 * <p>
 *     {@link #toMillis()} 提供和其他基于毫秒的计时操作最大的互操作性
 * </p>
 *
 * @author 琉璃
 * @date 2022年1月25日 14点36分
 */
export declare class TimeUnit {
    private static readonly MILLISECOND_VALUE;
    private static readonly SECOND_VALUE;
    private static readonly MINUTE_VALUE;
    private static readonly HOUR_VALUE;
    private static readonly DAY_VALUE;
    private static readonly WEEK_VALUE;
    private static readonly MONTH_VALUE;
    static readonly MILLISECOND: TimeUnit;
    static readonly SECOND: TimeUnit;
    static readonly MINUTE: TimeUnit;
    static readonly HOUR: TimeUnit;
    static readonly DAY: TimeUnit;
    static readonly WEEK: TimeUnit;
    static readonly 旬月: TimeUnit;
    static readonly MONTH: TimeUnit;
    /**
     * 当前时间单位的刻度毫秒值
     * @type {number}
     * @private
     */
    private readonly value;
    /**
     * 构造, 除非需要自定义时间单位, 否则使用静态实例常量即可
     * @param {number} value
     */
    constructor(value: number);
    /**
     * 转换到毫秒
     * @param {number} duration 数量, 默认 1
     * @returns {number} 毫秒值; 除非 size 有问题 否则永为整数
     */
    toMillis(duration?: number): number;
    /**
     * 转换到秒
     * 如果当前单位小于秒, 转换会出现小数
     * @param {number} duration
     */
    toSecond(duration: number): number;
    /**
     * 转换到分钟
     * 如果当前单位小于分钟, 转换会出现小数
     * @param {number} duration
     */
    toMinutes(duration: number): number;
    /**
     * 转换到小时
     * 如果当前单位小于小时, 转换会出现小数
     * @param {number} duration
     */
    toHours(duration: number): number;
    /**
     * 转换到天
     * 如果当前单位小于天, 转换会出现小数
     * @param {number} duration
     */
    toDays(duration: number): number;
    /**
     * 延迟执行
     * @param {PureCallback} fun
     * @param {number} timeout
     * @returns {number}
     */
    setTimeout(fun: PureCallback, timeout: number): number;
    /**
     * 定时器
     * @param {PureCallback} fun
     * @param {number} timeout
     * @returns {number}
     */
    setInt(fun: PureCallback, timeout: number): number;
    /**
     * 显示时间, 不考虑溢出
     * @param {number} time 当前单位的毫秒值
     * @param {boolean} h 主动显示, 即使为 00
     * @param {boolean} m 主动显示, 即使为 00
     * @param {boolean} s 主动显示, 即使为 00
     * @param {boolean} ms 是否显示
     * @return {string} 时间字符串
     */
    display(time: number, h?: boolean, m?: boolean, s?: boolean, ms?: boolean): string;
    private ifEmpty;
    private format;
}
//# sourceMappingURL=TimeUnit.d.ts.map