简介
Yearly 是一个基于 Moment.js 的 npm 包，能够快捷地生成简洁、易懂的年度时间范围。它可以帮助你快速创建类似 2021 年至 2022 年度间的时间范围，适用于个人和商业开发。本文将讲述如何使用 Yearly。
安装
要安装 Yearly, 首先需要确认已经安装了 Node.js。然后打开终端，输入以下命令：
npm install yearly
接着可以通过以下方式将它引入你的项目：
const yearly = require('yearly');使用
现在已经准备好使用 Yearly 了！下面我们来看看能够进行哪些操作。
基本使用
最基本的操作是在年份之间生成一个范围，看一个简单的例子：
const yearly = require('yearly');
const yearRange = yearly(2020, 2022);
console.log(yearRange);
// 输出：2020年至2022年度在年份之间生成一个指定时间范围
在上面的例子中，我们只是在年份之间生成了一个范围，但是我们还可以通过一些参数来生成指定时间范围。下面我们来看一下这些可选参数：
type：时间类型，可以为financial或fiscal，默认值为financial。startMonth：开始时间的月份，可以为 1 - 12 之间的任意整数，只在 type=fiscal 时有效，否则默认值为 1。endMonth：结束时间的月份，可以为 1 - 12 之间的任意整数，只在 type=fiscal 时有效，否则默认值为 12。format：时间格式，可以为 Moment.js 中的任意格式，如 YYYY-MM-DD，只在 type=financial 时有效，否则默认值为 YYYY 年 M 月。
看一个示例：
-- -------------------- ---- ------- ----- ------ - ------------------ ----- --------- - -------- ------ ----- ---- ----- ----- ------------ ------- ---------- --- ----------------------- -- -------------------
在这个例子中，我们传入了 type 和 format 这两个可选参数。这里我们设置了 type 为 financial，format 为 YYYY年M月，所以输出为 2020年1月至2022年12月。
高级使用
除了以上两个操作外，Yearly 还有许多其他的操作。我们可以使用 Moment.js 的方法对年份进行格式化，或者将该范围打印到 PDF 等等。
看一个高级使用的示例：
-- -------------------- ---- ------- ----- ------ - ------------------ ----- ------ - ------------------ ----- ------ - ------------------ ----- -- - -------------- ----- --------- - -------- ------ ----- ---- ----- ----- ------------ ------- ---------- --- ----- --- - --- --------- --------------------------------------------- ----------------- ----------------------------------- ----------- - ------ --------- --- --------------- ----------------- ----------------------------- - ------ --------- --- ----------
在这个示例中，我们使用了 Moment 和 PDFKit 类库生成了一个 PDF 文档。我们首先使用 yearly() 生成了一个年份范围，然后使用 Moment.js 按照格式化输出当前时间。最后我们将该年份范围打印到 PDF 文件中。
总结
本文介绍了如何使用 Yearly 这个 npm 包，它可以快捷地生成简洁、易懂的年度时间范围。我们学习了基本使用方法和一些高级例子，希望对你的项目有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056d1e81e8991b448e6e9d