js-moment v3.1.1

轻量级日期操作工具类 js-moment。

✨ 特性

• 轻量：gzip 大小不足3kb
• 精简：剔除 moment.js、day.js等日期组件的冗余方法，注重常用方法及开放性，暴露更多接口来支持各种场景
• 易用：完善的ts参数及方法提示，让您不查看文档也可玩转 js-moment
• 通用：包含通用的日期处理方法，包括日期加减、格式化、相对时间等常用方法

🖥 支持环境

• 现代浏览器和 IE9 及以上。

• node

📦 安装

>  npm install --save js-moment

  // esm
  import moment form 'js-moment';

  // commonjs
  const moment = require('js-moment');

🔨 示例

  const t = '2019-10-31 12:00:01';

  moment(t).format('YYYY-MM-dd');                 // 2019-10-31
  moment(t).format();                             // 2019-10-31 12:00:01
  moment(t).format('YYYY年MM月dd日') ;             // 2019年10月31日
  moment(t).format('YYYY-MM-dd 星期W AA h:m:s');   // 2019-10-31 星期四 下午 12:0:1
  moment(t).format('MMMMDD');                     // 十月三十一日
  moment(t).format('MMMM.DD.WW', 'en');           // October.31st.Thu
  moment(t).format('MMM dd, YYYY', 'en');         // Oct 31, 2019

  const t = '2019-10-31 12:00:01';

  moment(t).addYear(1);               // Moment {date: Sat Oct 31 2020 12:00:01 GMT+0800 (中国标准时间), dateObject: {…}}
  moment(t).addYear(1).format();      // 2020-10-31 12:00:01
  moment(t).addMonth(1).format();     // 2019-12-01 12:00:01
  moment(t).add(1).format();          // 2019-11-01 12:00:01
  moment(t).addDay(1).format();       // 2019-11-01 12:00:01
  moment(t).addTime(1).format();      // 2019-10-31 13:00:01
  moment(t).addTime(1, 'h').format(); // 2019-10-31 13:00:01
  moment(t).addTime(1, 'm').format(); // 2019-10-31 12:01:01
  moment(t).addTime(1, 's').format(); // 2019-10-31 12:00:02

默认方法

例：

  moment('2021-01-20 12:00:01').fromTo('2022-02-19 10:19:50').format();  // '1年后'
  moment('2021-02-20 12:00:01').fromTo('2022-02-19 10:19:50').format();  // '11个月29天后'
  moment('2022-01-20 12:00:01').fromTo('2022-01-13 10:19:50').format();  // '7天1小时前'
  moment('2022-01-20 12:00:01').fromTo('2022-01-20 10:19:50').format();  // '1小时40分钟前'
  moment('2022-01-20 12:00:01').fromTo('2022-01-20 12:19:50').format();  // '19分钟49秒后'

自定义格式

  moment('2021-01-20 12:00:01').fromTo('2022-02-19: 11:19:50').format('y年M个月d天'); // '1年0个月12天'
  moment('2021-01-20 12:00:01').fromTo('2022-02-19: 11:19:50').format('y年M个月d天h小时m分钟s秒'); // '1年0个月12天7小时11分钟18秒'

自定义拼接

注意：为方便使用，极大的提高方法的灵活性，本方法将所有时间参数均暴露出来，方法 Moment.fromTo() 返回分别包含（进制后）的日期时间数及 total 对象，total 对象中存放对应的日期间隔总数参考对比，在自定义拼接时需要两者配合使用，如下示例

  const { tag, years, months, days, hours, minutes, seconds, total } = moment(t).fromTo('2018-09-01 08:30:00');
  `发布于${total.months}个月${days}天${tag === '-' ? '之前' : '以后'}` // 发布于14个月5天之前
  `距离高考还有：${total.days}天${hours}小时${minutes}分钟${seconds}秒` // 距离高考还有：425天 3小时 30分钟 1秒 
  `闹钟将于${total.hours}小时${minutes}分钟${seconds}秒后响起` // 闹钟将于3小时30分钟30秒后响起

参数及使用说明

moment() 会返回一个 Moment 实例对象, 包含以下方法及属性;

Moment属性

• Moment.dateObject

  • year: number 年
  • month: number 月 0-11
  • day: number 日 1-31
  • hours: number 时 0-23
  • minutes: number 分 0-60
  • seconds: number 秒 0-60
  • time: number 时间戳
  • week: number 星期 0-6
  • quarter: number 季度 0-3

Moment方法

方法说明

1. format()

2. fromTo()

获取当前 Moment 对象与传入日期的差值 moment(date).formTo(date)

• 入参
  标准日期格式字符串（如 yyyy-MM-dd hh:mm:ss）| Date 对象

• 返回值

  属性名	说明	版本
  tag	标记时间的前后，'-'表示之前；'+'表示之后	v2.1.0
  years	相差的年月日时分秒中的年数(进制后)	v2.1.0
  months	同上，相差月数	v2.1.0
  days	同上，相差天数	v2.1.0
  hours	同上，相差小时数	v2.1.0
  minutes	同上，相差分钟数	v2.1.0
  seconds	同上，相差秒数	v2.1.0
  quarters	同上，相差的季度数	v3.0.0
  weeks	同上，相差的周数	v3.0.0
  o	总计相差的时间，包含年月日时分秒的集合 (v3.0.0以后移除)	v2.1.0
  total	总计相差的时间，包含年月日时分秒的集合，向下取整	v3.0.0
  wholeTotal	总计相差的时间，包含年月日时分秒的集合，包含小数（精确值）	v3.0.0
  format()	格式化日期差方法 方法说明	v2.1.0

• 2.1 fromTo().format().total 与 fromTo().format().years、fromTo().format().months ... 等对比

  • fromTo().format().total 日期时间总数，向下取整
  • fromTo().format().years、fromTo().format().months ...分别包含 年、月、日...

  属性名	说明	示例对应值
  total.years	包含总年数	1
  format().years	分别包含年数	1
  total.months	包含总月数	23
  format().months	分别包含月数	11
  total.days	包含总天数	702
  format().days	分别包含天数	2
  total.hours	包含总小时数	16858
  format().hours	分别包含小时数	10
  total.minutes	包含总分钟数	1011529
  format().minutes	分别包含分钟数	49
  total.seconds	包含总秒数	60691770
  format().seconds	分别包含秒数	30
  total.quarters	包含总季度数	7
  format().quarters	包含季度数	7
  total.weeks	包含总周数量	100
  format().weeks	包含总周数量	100

  示例：

  moment('2022-11-12 12:00:04').fromTo('2020-12-10 1:10:34')

• 2.2 fromTo().format()

  方法名	参数类型	默认值	版本	方法说明	返回值
  format	String	Null	v2.1.0	格式化相对日期	根据日期差自动生成，默认取两位

  示例：

  moment('2021-02-20 12:00:01').fromTo('2022-02-19 10:19:50').format();  // '11个月29天后'

  format 入参格式字符

  含义	年	月	日	时	分	秒
  字符	y	M	d	h	m	s

  示例：

  moment('2021-01-20 12:00:01').fromTo('2022-02-19: 11:19:50').format('y年M个月d天'); // '1年0个月12天'

  详情可参考 方法示例

3. add()

日期时间计算方法

• 入参

  参数	说明	必填	默认值
  count	计算数量 number	N	0
  type	计量单位 string 'year'\|'month'\|'day'\|'hour'\|'minute'\|'second'	N	'day'

• 返回值
  Moment 对象

更新日志

• v3.1.1
  支持 UTC (yyyy-MM-dd'T'HH:mm:ss.SSSZ) 转为标准北京时间。

• v3.1.0
  切换 Rollup.js 进行代码打包，支持 ES Module CommonJs 两种方式引入。

• v3.0.0

  1. 添加 typescript 语法校验提示，在ts项目中会自动提示相关参数及说明；
  2. 更新 format() 方法，新增中英文区分（zh | en），新增 月份MMMM、MMM、星期 WWW、WW）等格式化规则，需要注意，在v3.0.0以后，'DD'表示大写日期，即'一月 - 十二月，小写日期用'dd'表示参考format方法说明；
  3. 重构 formTo() 方法，v3.0.0以前月份采用固定的30天来计算，v3.0.0以后则以自然月进行计算；
  4. 新增 add() 方法，参考add()方法说明；
  5. Moment 对象新增 time 时间戳、week 星期、quarter 季度等字段；
  6. 修复其他已知bug；

• v2.2.1
  切换到webpack5.0进行代码编译，切换ts进行开发；

• v2.2.0
  增加 format 格式化方法的季度、星期等格式，详情见参数说明；
• v2.1.0
  增加fromTo方法，用于获取相对时间， 详情见参数说明↑；
• v2.0.0
  1. 增加方法的链式调用，moment().addDay()等方法将会返回当前的Moment对象，如 moment(t).addDay(1).addMonth(1).format()；
  2. 修复ios设备格式化时间显示 NAN 的bug；
• v1.0.0 基本的moment方法, 返回Moment对象，进行日期的计算及格式化等操作；

🔗 链接

• 项目地址
• my portfolio

🤝 参与共建

• author zhangjicheng
• Email zhangjichengcc@163.com