time.festival 库模块帮助文档

time.festival 成员列表 #

节日查询库
支持公历节日、农历节日、节气节日和周节日

time.festival.addLunarFestival(month,day,name,level,isLastDay) #

添加自定义农历节日

time.festival.addSolarFestival(month,day,name,level,startYear,endYear) #

添加自定义公历节日

time.festival.addWeekFestival(month,week,weekday,name,level) #

添加自定义周节日
week: -1 表示最后一周
weekday: 0 表示周日。
level 可选指定为 1 到 4 的整数值，可用 TIME_FESTIVAL 前缀的自动完成常量指定。

time.festival.get() #

返回对象:timeFestivalResultObject

time.festival.get(date,maxLevel) #

获取指定日期的所有节日
date: time对象、lunar对象、日期字符串或时间戳
maxLevel: 可选指定允许的节日重要性最大级别，默认值 3/*_TIME_FESTIVAL_NORMAL*/
返回节日信息表

time.festival.getByMonth(year,month,maxLevel) #

获取指定年月的所有节日，返回按日期排序的节日列表。

• 参数 @year 指定年份。
  
• 参数 @month 可选，不填返回全年节日
  
• 参数 @maxLevel 可选指定允许的节日重要性最大级别，默认值 3/*_TIME_FESTIVAL_NORMAL*/

time.festival.getDate(year,name) #

获取指定节日在某年的日期
返回 time 对象

time.festival.getMain(date) #

获取指定日期最重要的节日
返回节日信息对象

time.festival.getName(date,separator,maxLevel) #

获取指定日期的节日名称
返回用参数指定分隔符连接的节日名称字符串

• 参数 @date: 可指定 time对象、lunar对象、日期字符串或时间戳
  
• 参数 @separator 可选指定分隔符（字符串），默认为空格。
  
• 参数 @maxLevel 可选指定允许的节日重要性最大级别，默认值 3/*_TIME_FESTIVAL_NORMAL*/

time.festival.has(date,maxLevel) #

检查指定日期是否有节日
返回布尔值。

• 参数 @date: 可指定 time对象、lunar对象、日期字符串或时间戳。
  
• 参数 @maxLevel 可选指定允许的节日重要性最大级别，默认值 3/*_TIME_FESTIVAL_NORMAL*/

time.festival.isHoliday(date) #

检查指定日期是否是法定假日节日当天
返回 boolean

timeFestivalResultObject 成员列表 #

timeFestivalResultObject.date #

time 对象，查询的日期

timeFestivalResultObject.holidays #

法定假日列表

timeFestivalResultObject.important #

重要节日列表

timeFestivalResultObject.list #

所有节日列表

timeFestivalResultObject.lunar #

time.lunar 对象，农历日期

timeFestivalResultObject.lunarList #

农历节日列表

timeFestivalResultObject.solar #

公历节日列表

timeFestivalResultObject.term #

节气节日信息

自动完成常量

TIME_FESTIVAL_HOLIDAY=1/*_TIME_FESTIVAL_HOLIDAY*/_
TIME_FESTIVAL_IMPORTANT=2/*_TIME_FESTIVAL_IMPORTANT*/_
TIME_FESTIVAL_MINOR=4/*_TIME_FESTIVAL_MINOR*/_
TIME_FESTIVAL_NORMAL=3/*_TIME_FESTIVAL_NORMAL*/_

Markdown 格式