itcast-relative-time
v1.1.0
Published
轻量级相对时间格式化工具,将时间戳/Date对象转为人性化文本
Maintainers
Readme
itcast-relative-time
轻量级相对时间格式化工具,集成 dayjs 日期库,将时间戳/Date 对象转换为“刚刚、X分钟前”等人性化文本,适用于评论、订单、消息等时间展示场景。
安装
npm install itcast-relative-time使用
// ES Module 导入
import formatRelativeTime from 'yourname-relative-time'
// 示例 1:传入 Date 对象
console.log(formatRelativeTime(new Date()))
// 输出:刚刚
// 示例 2:传入毫秒级时间戳
console.log(formatRelativeTime(Date.now() - 180 * 1000))
// 输出:3 分钟前
// 示例 3:传入秒级时间戳
console.log(formatRelativeTime(1735324800))
// 输出:对应的相对时间时间粒度规则
| 时间范围 | 显示文本 | | ----------- | ----- | | ≤ 10 秒 | 刚刚 | | 10 秒 ~ 1 分钟 | X 秒前 | | 1 分钟 ~ 1 小时 | X 分钟前 | | 1 小时 ~ 1 天 | X 小时前 | | 1 天 ~ 30 天 | X 天前 | | 30 天 ~ 1 年 | X 个月前 | | > 1 年 | X 年前 |
参数说明
- time(必填):待格式化时间,支持 Date 对象、毫秒级时间戳、秒级时间戳。
- 返回值:格式化后的相对时间文本字符串。
