npm 包 @hentamine/lunar 使用教程

随着中国传统农历的不断普及和应用，越来越多的前端开发者需要在自己的项目中使用农历相关的计算和转换工具。而今天我们要介绍的 @hentamine/lunar 就是一款非常强大的 npm 包，它可以帮助开发者方便地进行农历和公历之间的转换。

1. 安装和使用

@hentamine/lunar 可以通过 npm 来安装，使用非常简单。首先，在你的项目中执行以下命令进行安装：

npm install @hentamine/lunar --save

安装完成后，我们就可以在项目中使用 @hentamine/lunar 提供的各种方法进行农历和公历之间的转换了。例如，以下是一个将公历日期转换为农历日期的示例代码：

const lunar = require('@hentamine/lunar');

let solarDate = new Date(2022, 0, 1);
let lunarDate = lunar.solarToLunar(solarDate);

console.log(lunarDate);

示例输出：

{
  year: 2021,
  month: 11,
  day: 19,
  leap: false,
  festival: null
}

2. API 说明

@hentamine/lunar 提供了以下几个 API：

2.1. solarToLunar(solarDate)

将公历日期转换为农历日期。

• 参数：
  • solarDate(Date)：要转换的公历日期。
• 返回值：
  • 对应的农历日期。
• 示例代码：

const lunar = require('@hentamine/lunar');

let solarDate = new Date(2022, 0, 1);
let lunarDate = lunar.solarToLunar(solarDate);

console.log(lunarDate);

示例输出：

{
  year: 2021,
  month: 11,
  day: 19,
  leap: false,
  festival: null
}

2.2. lunarToSolar(lunarDate)

将农历日期转换为公历日期。

• 参数：
  • lunarDate(Object)：要转换的农历日期，格式为 {year: 年, month: 月, day: 日, leap: 是否为闰月}。
• 返回值：
  • 对应的公历日期。
• 示例代码：

const lunar = require('@hentamine/lunar');

let lunarDate = {year: 2021, month: 11, day: 19, leap: false};
let solarDate = lunar.lunarToSolar(lunarDate);

console.log(solarDate);

示例输出：

2022-01-01T00:00:00.000Z

2.3. getLunarFestival(lunarDate)

获取某个农历日期的节日名称。

• 参数：
  • lunarDate(Object)：要获取的农历日期，格式为 {year: 年, month: 月, day: 日, leap: 是否为闰月}。
• 返回值：
  • 对应的节日名称，如未找到则返回 null。
• 示例代码：

const lunar = require('@hentamine/lunar');

let lunarDate = {year: 2021, month: 12, day: 30, leap: false};
let festival = lunar.getLunarFestival(lunarDate);

console.log(festival);

示例输出：

除夕

2.4. getSolarFestival(solarDate)

获取某个公历日期的节日名称。

• 参数：
  • solarDate(Date)：要获取的公历日期。
• 返回值：
  • 对应的节日名称，如未找到则返回 null。
• 示例代码：

const lunar = require('@hentamine/lunar');

let solarDate = new Date(2022, 0, 1);
let festival = lunar.getSolarFestival(solarDate);

console.log(festival);

示例输出：

元旦节

3. 总结

@hentamine/lunar 是一款非常实用的 npm 包，可以帮助前端开发者方便地进行农历和公历之间的转换，并且还提供了获取节日的方法，非常方便。希望本文对大家学习和使用 @hentamine/lunar 有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bb8967216659e2440cd