介绍
lunar-rover 是一个轻量级的 JavaScript 库,它提供了一个快速计算农历与阳历、节气、干支历、星座、时辰、胎神等信息的 API ,主要用于农历节日,节气气节,二十四节气等的查询。
安装
你可以通过 npm 来安装 lunar-rover:
npm install lunar-rover
使用
-- -------------------- ---- ------- ----- ---------- - ----------------------- ----- - ------ ----- - - ----------- -- ----------- ----- ------------ - --- -------- ----- ------------ - ------------------------ -- ----------- ----- ----------- - ------------------------------ -------------------------
输出结果:
-- -------------------- ---- ------- - ------- ------ ------- - ------- ----- -------- -- ------ - -- --------- ------ -------------- ----- -
API
Solar(year, month, day[, hour[, minute[, second[, millisecond]]]])
初始化一个阳历日期。
year
:年份(4 位数字)month
:月份(1 到 12)day
:日份(1 到 31)hour
:小时数(可选,默认为 0)minute
:分钟数(可选,默认为 0)second
:秒数(可选,默认为 0)millisecond
:毫秒数(可选,默认为 0)
Solar.fromYmd(year, month, day)
通过年月日初始化一个阳历日期。
year
:年份(4 位数字)month
:月份(1 到 12)day
:日份(1 到 31)
Solar.fromDate(date)
通过 Date 对象初始化一个阳历日期。
date
:Date 对象
Solar.fromString(str[, format])
通过字符串初始化一个阳历日期。
str
:字符串,如2022-02-12
format
:可选参数,表示字符串的日期格式,默认为YYYY-MM-DD
solar.getLunar()
获取阳历日期对应的农历信息。
返回一个 Lunar
对象。
solar.toDate()
将阳历日期转换成 Date 对象。
Lunar(year, month, day[, isLeapMonth])
初始化一个农历日期。
year
:农历年份month
:农历月份day
:农历日份isLeapMonth
:是否为闰月(可选,默认为 false)
Lunar.fromYmd(year, month, day[, isLeapMonth])
通过年月日初始化一个农历日期。
year
:农历年份month
:农历月份day
:农历日份isLeapMonth
:是否为闰月(可选,默认为 false)
Lunar.fromDate(date[, isLeapMonth])
通过 Date 对象初始化一个农历日期。
date
:Date 对象isLeapMonth
:是否为闰月(可选,默认为 false)
Lunar.fromString(str[, format][, isLeapMonth])
通过字符串初始化一个农历日期。
str
:字符串,如二〇二二年正月初一
format
:可选参数,表示字符串的日期格式,默认为YYYY年MM月DD日
isLeapMonth
:是否为闰月(可选,默认为 false)
lunar.getDaysInMonth([isLeapMonth])
获取当前月份的天数。
isLeapMonth
:是否为闰月(可选,默认为 false)
lunar.getLeapMonth()
获取当前年份的闰月月份。
如果当前年份没有闰月,返回 0。
lunar.getNextHoliday()
获取下个农历节日的日期信息。
返回一个对象,包含以下属性:
name
:节日名称date
:阳历日期对象,包含year
、month
、day
三个字段isLeap
:是否为闰年isLeapMonth
:是否为闰月
示例代码
-- -------------------- ---- ------- ----- ---------- - ----------------------- ----- - ------ ----- - - ----------- -- ----------- ----- ------------ - --- -------- ----- ------------ - ------------------------ -- ----------- ----- ----------- - ------------------------------ -------------------------
结语
lunar-rover 是一款轻量级的 JavaScript 库,它提供了丰富的 API,让我们可以快速计算农历与阳历、节气、干支历、星座、时辰、胎神等信息,大大方便了我们农历相关信息的查询。希望本文的介绍和使用指南对你有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60067350890c4f72775838b0