1.2.3 • Published 3 years ago

@z-yue/calendar v1.2.3

Weekly downloads
4
License
MIT
Repository
github
Last release
3 years ago

@z-yue/calendar

日历工具,获取指定时间的农历(阴历)信息。包括阳历节日、阴历节日。

Usage

import Calendar from '@z-yue/calendar'
const calendar = new Calendar(new Date(2020, 11, 31))
console.log(calendar)

Result

{
  "now": "2020-12-30T16:00:00.000Z",
  "year": 2020,
  "month": 12,
  "date": 30,
  "day": 3,
  "isTombSweeping": false,
  "isValentineDay": false,
  "isAprilFoolDay": false,
  "isChristmas": false,
  "isHalloween": false,
  "isNewYear": false,
  "festival": "",
  "fullFestival": "",
  "lunar": {
    "now": "庚子年11月17日 0:00:00",
    "full": "庚子年冬月十七",
    "year": "庚子年",
    "month": 11,
    "date": 17,
    "lunarMonth": "冬月",
    "lunarDate": "十七",
    "isBigMonth": true,
    "isSmallMonth": false,
    "isNewYear": false,
    "isLantern": false,
    "isDoubleSeventh": false,
    "isDoubleNinth": false,
    "isMidAutumn": false,
    "festival": ""
  }
}

结果参数类型 Calendar 阳(公)历

参数描述类型
now当前时间Date
year当前年份number
month当前月份number
date当前日期number
day周几number
isTombSweeping清明节 🙇🏻boolean
isValentineDay清明节 🌹boolean
isAprilFoolDay愚人节 🤡boolean
isChristmas圣诞节 🎄boolean
isHalloween万圣节 🎃boolean
isNewYear新年 🎉boolean
festival节日string
fullFestival节日(阳历 阴历)空格分隔string

结果参数类型 ChineseCalendar 阴(农)历

参数描述类型
now当前时间Date
year当前阴历年份number
month当前阴历月份number
date当前阴历日期number
lunarMonth当前阴历中文月份string
lunarDate当前阴历中文日期string
isBigMonth是否阴历大月(30 天)boolean
isSmallMonth是否阴历小月(29 天)boolean
isNewYear新年 🎉boolean
isLantern元宵节 🥣boolean
isDoubleSeventh七夕节 🎋boolean
isDoubleNinth重阳节 🌱boolean
isMidAutumn中秋节 🥮boolean
festival节日string