Variable timeUtilsConst

Type declaration

• beforeOrAfterDay:function

  • beforeOrAfterDay(dateString): string

  • 根据当前时间计算出传递的时间是几天前或者几天后

    Parameters

    • dateString: string

      时间字符串

    Returns string

    计算后的返回结果

    Example

    timeUtils.beforeOrAfterDay('2024-10-21 23:11:11') // 3天前
    timeUtils.beforeOrAfterDay('2024-10-24 23:11:11') // 今天
    timeUtils.beforeOrAfterDay('2024-11-24 23:11:11') // 31天后
    Copy

• chineseDate:function

  • chineseDate(dateTime?, isYear?): string

  • 转时间加文字 例：(2022-12-01 转 2022年12月01日) || (12-01 转 12月01日)；

    Parameters

    • dateTime: undefined | null | string | number | Date = null

      时间戳，时间字符串（仅支持 转 年月日字符）
    • isYear: boolean = true

      是否有年 默认为true 转 2022年10月12日, false 转 10月12日

    Returns string

    返回格式化后的字符串

    Example

    timeUtils.chineseDate('2023-12-01',false) // 12月01日
    timeUtils.chineseDate('2023-12-01') // 2023年12月01日
    Copy

• endTime:function

  • endTime(dateTime): string

  • 年月日 + 23:59:59

    Parameters

    • dateTime: undefined | null | string | number | Date

      date不传或传入null 表示取当前时间

    Returns string

    年月日 + 23:59:59

    Example

    timeUtils.endTime('2024-02-15 15:12:18') // 2024-02-15 23:59:59
    timeUtils.startTime('') // 2024-08-14 23:59:59
    Copy

• getDaysBetweenInclude:function

  • getDaysBetweenInclude(startDate, endDate, isIncludeEnd?): number

  • 计算两个日期之间的天数

    Parameters

    • startDate: string | Date

      开始日期（支持字符串或 Date 对象）
    • endDate: string | Date

      结束日期（支持字符串或 Date 对象）
    • isIncludeEnd: boolean = true

      是否包含结束日期（默认 true）

    Returns number

    返回两个日期之间的天数

    Example

    getDaysBetweenInclude('2026-03-01', '2026-03-05') // 5（包含首尾）
    getDaysBetweenInclude('2026-03-01', '2026-03-05', false) // 4（不包含结束）
    Copy

    Description

    • 仅按“自然日”计算（忽略时分秒）
    • 内部使用 UTC 方式，避免时区导致的误差问题
    • 自动处理开始日期大于结束日期的情况（取绝对值）

• getOffsetDateStr:function

  • getOffsetDateStr(dateStr, days): string

  • 根据基准日期计算偏移后的日期字符串

    Parameters

    • dateStr: string | Date

      基准日期（支持 'YYYY-MM-DD' 或 Date 对象）
    • days: number

      偏移天数： 正数表示往后（未来）days 天， 负数表示往前（过去）|days| 天

    Returns string

    偏移后的日期字符串，格式为 'YYYY-MM-DD'

    Example

    getOffsetDateStr('2026-01-30', -3) // '2026-01-27'
    getOffsetDateStr('2026-01-30', 3)  // '2026-02-02'
    Copy

    Description

    • 使用 UTC 计算，避免时区导致的日期偏移问题
    • 自动补零，保证格式为 YYYY-MM-DD

• isAfterNow:function

  • isAfterNow(dateString): boolean

  • 当前时间和传递的时间进行比较，传递的时间大于当前时间返回true 小于则返回false

    Parameters

    • dateString: string

      时间字符串

    Returns boolean

    Example

    timeUtils.isAfterNow('2024-10-21 23:11:11') // false
    timeUtils.isAfterNow('2024-10-24 23:11:11') // true
    timeUtils.isAfterNow('2024-11-24 23:11:11') // true
    Copy

• nowFullTime:function

  • nowFullTime(): string

  • 当前时间的完整显示 timeFormat(null, "yyyy-mm-dd hh:MM:ss")

    Returns string

    yyyy-mm-dd hh:MM:ss 格式时间

    Example

    timeUtils.nowFullTime() // 2024-01-01 17:11:35
    Copy

• nowTimestamp:function

  • nowTimestamp(isUnix?): number

  • 当前时间时间戳

    Parameters

    • isUnix: boolean = false

      普通的为 13位(包含毫秒); unix 的为10位，不包含毫秒

    Returns number

    时间戳数值

    Example

    timeUtils.nowTimestamp() // 1723624829143
    timeUtils.nowTimestamp(false) // 1723624829
    Copy

• startTime:function

  • startTime(dateTime): string

  • 年月日 + 00:00:00

    Parameters

    • dateTime: undefined | null | string | number | Date

      date不传或传入null 表示取当前时间

    Returns string

    年月日 + 00:00:00

    Example

    timeUtils.startTime('1710486738911') // 2024-03-15 00:00:00
    timeUtils.startTime('') // 2024-08-14 00:00:00
    Copy

• timeFormat:function

  • timeFormat(dateTime?, formatStr?, emptyResult?): string

  • 格式化时间，输出时间字符串, yyyy-mm-dd hh:MM:ss

    Parameters

    • dateTime: undefined | null | string | number | Date = null

      时间，时间字符串，时间戳，时间戳字符串都可以。date不传或传入null 表示取当前时间
    • formatStr: string = 'yyyy-mm-dd'

      格式化规则 yyyy:mm:dd|yyyy:mm|yyyy年mm月dd日|yyyy年mm月dd日 hh时MM分等,可自定义组合 默认yyyy-mm-dd。yyyy-mm-dd hh:MM:ss 显示时分秒
    • emptyResult: string = "-"

    Returns string

    返回格式化后的字符串

    Example

    timeUtils.timeFormat('1710486738911','yyyy-mm-dd hh:MM:ss') // 2024-03-15 15:12:18
    timeUtils.timeFormat('1710486738911','mm-dd hh:MM') // 03-15 15:12
    timeUtils.timeFormat('1710486738911','yyyy年mm月dd日 hh时MM分') // 2024年03月15日 15时12分
    Copy

• timeFrom:function

  • timeFrom(date?, format?, emptyResult?): string

  • 距离现在多久

    Parameters

    • date: undefined | null | string | number | Date = null

      时间，时间字符串，时间戳，时间戳字符串都可以。date不传或传入null 表示取当前时间
    • format: string = 'yyyy-mm-dd'

      格式化规则如果为时间格式字符串，超出一定时间范围，返回固定的时间格式； 如果为布尔值false，无论什么时间，都返回多久以前的格式
    • emptyResult: string = "-"

    Returns string

    转化后的内容

    Example

    timeUtils.timeFrom(timeUtils.nowFullTime()) // 刚刚
    timeUtils.timeFrom(timeUtils.nowTimestamp() - 3600000) // 1小时前
    Copy

• toDate:function

  • toDate(dateTime?): Date

  • 转时间

    Parameters

    • Optional dateTime: null | string | number | Date

      时间，时间字符串，时间戳，时间戳字符串都可以 date不传或传入null 表示取当前时间

    Returns Date

    Example

    timeUtils.toDate('1710486738911') // 2024-03-15T07:12:18.911Z
    timeUtils.toDate(null) // 2024-08-14T08:44:22.991Z
    Copy

• toTimestamp:function

  • toTimestamp(dateTime, isUnix?): number

  • 转时间戳

    Parameters

    • dateTime: undefined | null | string | number | Date

      时间，时间字符串，时间戳，时间戳字符串都可以 date不传或传入null 表示取当前时间
    • isUnix: boolean = false

      是否为unix格式

    Returns number

    Example

    timeUtils.toTimestamp(null) // 1723625151828
    timeUtils.toTimestamp(null,true) // 1723625151
    timeUtils.toTimestamp('2024-02-15 15:12:18') // 1707981138000
    Copy