Day.js 2kb的时间处理库 全功能精简版的 Moment 中文文档

English | 简体中文

Moment.js 的 2kB 轻量化方案，拥有同样强大的 API

Day.js 是一个轻量的 JavaScript 时间日期处理库，和 Moment.js 的 API 设计保持完全一样. 如果你曾经用过 Moment.js, 那么你已经知道如何使用 Day.js

dayjs().startOf('month').add(1, 'day').set('year', 2018).format('YYYY-MM-DD HH:mm:ss');

• 🕒 和 Moment.js 相同的 API 和用法
• 💪 不可变数据 (Immutable)
• 🔥 支持链式操作 (Chainable)
• 📦 仅 2kb 大小的微型库
• 👫 全浏览器兼容

---

安装

可以有如下多种方法安装使用 Day.js:

• NPM:

    npm install dayjs --save

    var dayjs = require('dayjs');
    dayjs().format();

• CDN:

    <!-- Latest compiled and minified JavaScript -->
    <script src="https://unpkg.com/dayjs"></script>
    <script>
      dayjs().format();
    </script>

• 下载到您自己的服务器上:

从 unpkg.com/dayjs 下载最新的 Dayjs 源文件，并自行部署到您的服务器上。

开始

Dayjs 并没有改变或覆盖 Javascript 原生的 Date.prototype， 而是创造了一个全新的包含 Javascript Date 对象的 Dayjs 的对象。

Dayjs 对象是不可变的, 所有的 API 操作都将返回一个新的 Dayjs 对象。

API

如果没有特别说明，API 的返回值都是新的 Dayjs 对象。

• 解析
  • 当前时间
  • 时间字符串
  • Unix 时间戳 (毫秒)
  • Date 对象
  • 复制
  • 验证
• 获取+设置
  • 年
  • 月
  • 日
  • 时
  • 分
  • 秒
  • 毫秒
  • 设置
• 操作
  • 增加
  • 减少
  • 开头时间
  • 末尾时间
• 显示
  • 格式化
  • 时间差
  • Unix 时间戳 (毫秒)
  • Unix 时间戳 (秒)
  • 天数 (月)
  • Date 对象
  • 数组
  • JSON
  • ISO 8601 字符串
  • 对象
  • 字符串
• 查询
  • 是否之前
  • 是否相同
  • 是否之后
  • 是否闰年

---

解析

在 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().hour();

分

• return Number

获取分钟。

dayjs().minute();

秒

• return Number

获取秒。

dayjs().second();

毫秒

• return Number

获取毫秒。

dayjs().millisecond();

设置

设置时间 传入的单位 (unit) 对大小写不敏感。

dayjs().set(unit : String, value : Int);
dayjs().set('month', 3);  // April
dayjs().set('second', 30);

---

操作

你可以对 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"); // "[2014] 09-08T08:02:17-05:00"

时间差

• 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

是否闰年

• return Boolean

是否闰年。

dayjs().isLeapYear();
dayjs('2000-01-01').isLeapYear(); // true

---

开源协议

MIT