转载自 dayjs
API
Dayjs
并没有改变或覆盖 Javascript 原生的 Date.prototype
, 而是创造了一个全新的包含 Javascript Date
对象的 Dayjs
的对象。
Dayjs
对象是不可变的, 所有的 API 操作都将返回一个新的 Dayjs
对象。
- 解析
- 当前时间
- 时间字符串
- Unix 时间戳 (毫秒)
- Date 对象
- 复制
- 验证
- 获取+设置
- 年
- 月
- 日
- 星期
- 时
- 分
- 秒
- 毫秒
- 设置
- 操作
- 增加
- 减少
- 开头时间
- 末尾时间
- 显示
- 格式化
- 时间差
- Unix 时间戳 (毫秒)
- Unix 时间戳 (秒)
- 天数 (月)
- Date 对象
- 数组
- JSON
- ISO 8601 字符串
- 对象
- 字符串
- 查询
- 是否之前
- 是否相同
- 是否之后
- 是否是 Dayjs
.isDayjs()
- 插件 APIs
- 相对时间
- 是否是闰年
- 年中的第几周
- 是否之间
如果没有特别说明,Day.js 的返回值都是新的 Dayjs
对象。
解析
在 dayjs()
中传入支持的格式
当前时间
直接运行 dayjs()
,得到包含当前时间和日期的 Dayjs
对象。
dayjs();
时间字符串
可以解析传入的一个标准的ISO 8601时间字符串。
dayjs(String);
dayjs("1995-12-25");
Unix 时间戳 (毫秒)
可以解析传入的一个 Unix 时间戳 (13位数字)。
dayjs(Number);
dayjs(1318781876406);
Date 对象
可以解析传入的一个 Javascript Date 对象。
dayjs(Date);
dayjs(new Date(2018, 8, 18));
复制
Dayjs
对象是不可变的,如果您想获得一个对象的拷贝,请执行 .clone()
。 向 dayjs()
里传入一个 Dayjs
对象也能实现同样的效果。
dayjs(Dayjs);
dayjs().clone();
验证
- return Boolean
检测当前 Dayjs
对象是否是一个有效的时间。
dayjs().isValid();
获取+设置
获取和改变日期。
年
- return Number
获取年份。
dayjs().year();
月
- return Number
获取月份。
dayjs().month();
日
- return Number
获取日期。
dayjs().date();
星期
- return Number
获取星期。
dayjs().day();
时
- return Number
获取小时。
dayjs().hour();
分
- return Number
获取分钟。
dayjs().minute();
秒
- return Number
获取秒。
dayjs().second();
毫秒
- return Number
获取毫秒。
dayjs().millisecond();
设置
设置时间 传入的单位 (unit) 对大小写不敏感。
dayjs().set(unit : String, value : Int);
dayjs().set('date', 1);
dayjs().set('month', 3); // 四月
dayjs().set('second', 30);
可用单位
单位 | 缩写 | 描述 |
---|---|---|
date | 日期 | |
day | d | 星期几 (星期天 0, 星期六 6) |
month | M | 月 |
year | y | 年 |
hour | h | 时 |
minute | m | 分 |
second | s | 秒 |
millisecond | ms | 毫秒 |
操作
您可以对 Dayjs
对象如下增加减少之类的操作:
dayjs().startOf('month').add(1, 'day').subtract(1, 'year')
增加
增加时间并返回一个新的 Dayjs()
对象。
dayjs().add(value : Number, unit : String);
dayjs().add(7, 'day');
减少
减少时间并返回一个新的 Dayjs()
对象,使用方法和 dayjs#add
相同。
dayjs().subtract(value : Number, unit : String);
dayjs().subtract(7, 'year');
开头时间
返回当前时间的开头时间的 Dayjs()
对象,如月份的第一天。
dayjs().startOf(unit : String);
dayjs().startOf('year');
末尾时间
返回当前时间的末尾时间的 Dayjs()
对象,如月份的最后一天。
dayjs().endOf(unit : String);
dayjs().endOf('month');
显示
格式化 Dayjs
对象并展示。
格式化
- return String
接收一系列的时间日期字符串并替换成相应的值。
dayjs().format(String);
dayjs().format(); // "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds)
dayjs().format("{YYYY} MM-DDTHH:mm:ssZ[Z]"); // "{2014} 09-08T08:02:17-05:00Z"
详情如下:
Format | Output | Description |
---|---|---|
YY | 18 | 两位数的年份 |
YYYY | 2018 | 四位数的年份 |
M | 1-12 | 月份,从 1 开始 |
MM | 01-12 | 月份,两位数 |
MMM | Jan-Dec | 简写的月份名称 |
MMMM | January-December | 完整的月份名称 |
D | 1-31 | 月份里的一天 |
DD | 01-31 | 月份里的一天,两位数 |
d | 0-6 | 一周中的一天,星期天是 0 |
dd | Su-Sa | 最简写的一周中一天的名称 |
ddd | Sun-Sat | 简写的一周中一天的名称 |
dddd | Sunday-Saturday | 一周中一天的名称 |
H | 0-23 | 小时 |
HH | 00-23 | 小时,两位数 |
m | 0-59 | 分钟 |
mm | 00-59 | 分钟,两位数 |
s | 0-59 | 秒 |
ss | 00-59 | 秒 两位数 |
SSS | 000-999 | 秒 三位数 |
Z | +5:00 | UTC 的偏移量 |
ZZ | +0500 | UTC 的偏移量,数字前面加上 0 |
A | AM PM | |
a | am pm |
- 更多格式化的选项
Q Do k kk X x ...
可以使用插件AdvancedFormat
时间差
- return Number
获取两个 Dayjs
对象的时间差,默认毫秒。
dayjs().diff(Dayjs, unit);
dayjs().diff(dayjs(), 'years'); // 0
Unix 时间戳 (毫秒)
- return Number
返回 Unix 时间戳 (毫秒)
dayjs().valueOf();
Unix 时间戳 (秒)
- return Number
返回 Unix 时间戳 (秒)。
dayjs().unix();
天数 (月)
- return Number
返回月份的天数。
dayjs().daysInMonth();
Date 对象
- return Javascript
Date
object
返回原生的 Date
对象。
dayjs().toDate();
数组
- return Array
返回包含时间数值的数组。
dayjs().toArray(); //[2018, 8, 18, 00, 00, 00, 000];
As JSON
- return JSON String
当序列化 Dayjs
对象时,会返回 ISO8601 格式的字符串。
dayjs().toJSON(); //"2018-08-08T00:00:00.000Z"
ISO 8601 字符串
- return String
返回 ISO8601 格式的字符串。
dayjs().toISOString();
对象
- return Object
返回包含时间数值的对象。
dayjs().toObject();// { years:2018, months:8, date:18, hours:0, minutes:0, seconds:0, milliseconds:0}
字符串
- return String
dayjs().toString();
查询
是否之前
- return Boolean
检查一个 Dayjs
对象是否在另一个 Dayjs
对象时间之前。
dayjs().isBefore(Dayjs);
dayjs().isBefore(dayjs()); // false
是否相同
- return Boolean
检查一个 Dayjs
对象是否和另一个 Dayjs
对象时间相同。
dayjs().isSame(Dayjs);
dayjs().isSame(dayjs()); // true
是否之后
- return Boolean
检查一个 Dayjs
对象是否在另一个 Dayjs
对象时间之后。
dayjs().isAfter(Dayjs);
dayjs().isAfter(dayjs()); // false
是否是 Dayjs .isDayjs(compared: any)
返回一个 boolean
验证传入值是否是一个 Dayjs 对象.
dayjs.isDayjs(dayjs()); // true
dayjs.isDayjs(new Date()); // false
插件 APIs
相对时间
.from
.to
.fromNow
.toNow
获得相对时间
插件 RelativeTime
是否是闰年
.isLeapYear
获得是否闰年
插件 IsLeapYear
年中的第几周
.week
获取是第几个周
插件 WeekOfYear
是否之间
.isBetween
返回一个时间是否介于两个时间之间