[JavaScript知识库]《JavaScript插件》时间格式化工具time-formater的详解

记录一些项目中用的到的插件，方便以后及时翻看…
～
求关注，求收藏，求点赞，如果发现博主有写的不合理的地方请及时告知，谢谢~

前言

在实际项目的开发中，一个中大型项目往往会使用到非常多插件、工具，如果说一个项目全部靠团队开发，那明显是不现实的，且不说存在重复造轮子的问题，如果要将工具开发的具有较强的应用性还是要投入非常大的精力的（除非是业务的特殊性导致没有任何插件或工具符合期望）；
?
本系列的文章主要目的是记录日常开发中应用到的JS插件，并且将一些用法记录下来，方便自己以及各位小伙伴查阅；

本文的主角：time-formater（npm地址），这是一个时间格式化工具，虽然有点小众，并且也没有@types，这也就导致了无法在TypeScript中应用，可能有人会问那这为啥还要用…不要问
?

安装与使用

安装就是常规的安装方式，再次声明，没有@types/time-formater，需要自己补上

// 安装
npm i -S time-formater

使用的话在Node中和浏览器环境都差不多，只是规范不同

// 可以
const timeFormater = require('time-formater')

// 也可以
import timeFormater from "time-formater";

语法

解析参数

format函数接收许多预设定好的形参作为参数（其它参数见第二章节），比如最常见的"YYYY-MM-DD HH:mm:ss"，代表当前时间并且精确到秒

// 2022-02-09 12:12:12
timeFormater().format("YYYY-MM-DD HH:mm:ss")

这是当前的全时间，如果要裁剪都是支持的，比如

// 2022-02-09 12:12
timeFormater().format("YYYY-MM-DD HH:mm")

// 2022-02-09 12
timeFormater().format("YYYY-MM-DD HH")

甚至连接符也可以改

// 2022/02/09 12/12/12
timeFormater().format("YYYY/MM/DD HH/mm/ss")

参数

format函数的使用参数远不止上面这些，它接收许多预设定好的参数，比如想知道当前是星期几，那么可以输入参数"d"

// 三
timeFormater().format("dd")

// // 2022/三月/09 12/12/12
timeFormater().format("YYYY/MMMM/DD HH/mm/ss")

具体如下：

其他功能

时差

fromNow，用于计算输入时间距离当前时间的时差，用法如下：

let fromNow = time('2022-01-01').fromNow()

// 2个月前
console.log(fromNow)

?

倒计时

例子来源于npm官方说明，大致功能如下：

const time = require('time-formater')
let remain = 100000 // 10万秒
let countdown = time.countdown(remain)
let token = '剩余：d天H小时m分钟s秒'
 
// 浏览器
function step() {
    document.title = countdown.format(token) // 剩余：1天3小时46分钟40秒
    requestAnimationFrame(step)
}
step()

这里用到了，两个函数，一个是countdown，一个是countdown上的format
?

countdown

返回倒计时的时间量。

• time <number | string | Date> 类型为数字表示剩余的秒数，为Date实例或字符串（符合ISO 8601格式），表示结束的时间点。

?

format(token)

将时间量格式化为字符串。

• token 用于指定输出格式。例：‘剩余：d天H小时m分钟s秒’ => “剩余：1天11小时4分钟38秒”。

TypeScript类型

很遗憾，这个插件没有提供类型，只能自己根据类型自己去补充，大致类型补充如下：

interface countdownFormat {
    format: (params: string) => string;
}

interface FormaterInterface {
    format: (params?: string | number) => string;
    fromNow: () => string;
    countdown: (params: number | string | date) => countdownFormat;
}

declare module "time-formater" {
    function timeFormater(params?: string | number): FormaterInterface {}

    export = timeFormater;
}

可能还不是非常完整，有兴趣额的小伙伴可以进一步补充；
?

小结

这是一个个人感觉比较好用的时间格式化工具，唯一的缺点就是作者好像后期没有继续对其维护，包括对TypeScript的支持也非常不友好，这一点需要自己弥补，除此之外个人感觉还是非常不错的，值得推荐；