# time.almanac 库模块帮助文档

<details>  <summary>民俗展示</summary>  <p>

## 范围与约定

- 纯 aardio 黄历内容层，不需要 JavaScript、.NET 或网络；可另配 time.lunar 展示农历日期。
- 支持公历 1901-01-01 至 2100-12-31。输入为北京时间的公历墙钟时间，不自动换算时区或真太阳时。
- 日宜忌与日神煞按节气月取值，交节当天整日换月；日干支在 0 点换日。
- 时辰宜忌在 23 点按次日日干支查表。getHours 按公历日返回 13 段，早子与晚子分列。
- yi/ji 是独立字符串数组，空数组保持为空，不自行填成“诸事不宜”。
- isLucky 仅指十二值神的黄道/黑道分类，不是宜忌综合评分。
- 词条、神煞与彭祖百忌来自民俗资料，彼此可能相矛盾，请勿用于医疗或现实决策。

</p></details>

[民俗黄历](https://www.aardio.com/zh-cn/docs/library/time/almanac/)

## time 成员列表 <a id="time" href="#time">&#x23;</a>

### time.almanac() <a id="time.almanac" href="#time.almanac">&#x23;</a>
[返回对象:timeAlmanacDayObject](#timeAlmanacDayObject)

### time.almanac(date) <a id="time.almanac" href="#time.almanac">&#x23;</a>
创建日黄历快照。参数为公历 time 对象、日期字符串或时间戳；省略为今天。  

[返回对象:timeAlmanacDayObject](#timeAlmanacDayObject)

## time.almanac 成员列表 <a id="time.almanac" href="#time.almanac">&#x23;</a>

民俗黄历：宜忌、神煞与时辰信息。纯 aardio，离线可用。

### time.almanac.getDay(date) <a id="time.almanac.getDay" href="#time.almanac.getDay">&#x23;</a>
获取日黄历，忽略时分秒。失败返回 null,err。  

[返回对象:timeAlmanacDayObject](#timeAlmanacDayObject)

### time.almanac.getHour(date) <a id="time.almanac.getHour" href="#time.almanac.getHour">&#x23;</a>
获取指定时刻的时辰宜忌；23点按次日日干支查表。失败返回 null,err。  

[返回对象:timeAlmanacHourObject](#timeAlmanacHourObject)

### time.almanac.getHours(date) <a id="time.almanac.getHours" href="#time.almanac.getHours">&#x23;</a>
获取公历当天全部13段时辰（早子与晚子分列），返回数组。失败返回 null,err。

### time.almanac.getSource() <a id="time.almanac.getSource" href="#time.almanac.getSource">&#x23;</a>
获取黄历数据来源、版本、哈希等。

### time.almanac.nowBeijing() <a id="time.almanac.nowBeijing" href="#time.almanac.nowBeijing">&#x23;</a>
返回当前北京时间，不依赖电脑的时区设置。

## timeAlmanacDayObject 成员列表 <a id="timeAlmanacDayObject" href="#timeAlmanacDayObject">&#x23;</a>

### timeAlmanacDayObject.badGods <a id="timeAlmanacDayObject.badGods" href="#timeAlmanacDayObject.badGods">&#x23;</a>
凶煞宜忌：字符串数组。

### timeAlmanacDayObject.clash <a id="timeAlmanacDayObject.clash" href="#timeAlmanacDayObject.clash">&#x23;</a>
日冲生肖，如马。

### timeAlmanacDayObject.date <a id="timeAlmanacDayObject.date" href="#timeAlmanacDayObject.date">&#x23;</a>
公历日期字符串。

### timeAlmanacDayObject.day <a id="timeAlmanacDayObject.day" href="#timeAlmanacDayObject.day">&#x23;</a>
日干支。  

[返回对象:timeAlmanacPillarObject](#timeAlmanacPillarObject)

### timeAlmanacDayObject.duty <a id="timeAlmanacDayObject.duty" href="#timeAlmanacDayObject.duty">&#x23;</a>
建除十二神，如建、除、满、平。

### timeAlmanacDayObject.ecliptic <a id="timeAlmanacDayObject.ecliptic" href="#timeAlmanacDayObject.ecliptic">&#x23;</a>
黄道或黑道。

### timeAlmanacDayObject.fetus <a id="timeAlmanacDayObject.fetus" href="#timeAlmanacDayObject.fetus">&#x23;</a>
胎神占方。

### timeAlmanacDayObject.getHours() <a id="timeAlmanacDayObject.getHours" href="#timeAlmanacDayObject.getHours">&#x23;</a>
构造所得对象提供此方法，返回当天13段时辰数组。

### timeAlmanacDayObject.goodGods <a id="timeAlmanacDayObject.goodGods" href="#timeAlmanacDayObject.goodGods">&#x23;</a>
吉神宜趋：字符串数组。

### timeAlmanacDayObject.isLucky <a id="timeAlmanacDayObject.isLucky" href="#timeAlmanacDayObject.isLucky">&#x23;</a>
是否黄道，仅表示十二值神的分类。

### timeAlmanacDayObject.ji <a id="timeAlmanacDayObject.ji" href="#timeAlmanacDayObject.ji">&#x23;</a>
忌：字符串数组。

### timeAlmanacDayObject.joyDirection <a id="timeAlmanacDayObject.joyDirection" href="#timeAlmanacDayObject.joyDirection">&#x23;</a>
喜神方位。

### timeAlmanacDayObject.mansion <a id="timeAlmanacDayObject.mansion" href="#timeAlmanacDayObject.mansion">&#x23;</a>
二十八宿名称。

### timeAlmanacDayObject.mansionFullName <a id="timeAlmanacDayObject.mansionFullName" href="#timeAlmanacDayObject.mansionFullName">&#x23;</a>
二十八宿完整名称，如角木蛟。

### timeAlmanacDayObject.mascotDirection <a id="timeAlmanacDayObject.mascotDirection" href="#timeAlmanacDayObject.mascotDirection">&#x23;</a>
福神方位。

### timeAlmanacDayObject.month <a id="timeAlmanacDayObject.month" href="#timeAlmanacDayObject.month">&#x23;</a>
干支月（交节当日整日切换），非农历月。  

[返回对象:timeAlmanacPillarObject](#timeAlmanacPillarObject)

### timeAlmanacDayObject.pengZu <a id="timeAlmanacDayObject.pengZu" href="#timeAlmanacDayObject.pengZu">&#x23;</a>
彭祖百忌：两条字符串。

### timeAlmanacDayObject.sha <a id="timeAlmanacDayObject.sha" href="#timeAlmanacDayObject.sha">&#x23;</a>
日煞方位，如南。

### timeAlmanacDayObject.solarTerm <a id="timeAlmanacDayObject.solarTerm" href="#timeAlmanacDayObject.solarTerm">&#x23;</a>
当天节气名称；无节气为空字符串。

### timeAlmanacDayObject.twelveStar <a id="timeAlmanacDayObject.twelveStar" href="#timeAlmanacDayObject.twelveStar">&#x23;</a>
十二值神，如青龙、明堂、天刑。

### timeAlmanacDayObject.wealthDirection <a id="timeAlmanacDayObject.wealthDirection" href="#timeAlmanacDayObject.wealthDirection">&#x23;</a>
财神方位。

### timeAlmanacDayObject.yangNobleDirection <a id="timeAlmanacDayObject.yangNobleDirection" href="#timeAlmanacDayObject.yangNobleDirection">&#x23;</a>
阳贵神方位。

### timeAlmanacDayObject.year <a id="timeAlmanacDayObject.year" href="#timeAlmanacDayObject.year">&#x23;</a>
干支年（立春当日整日切换），非农历年。  

[返回对象:timeAlmanacPillarObject](#timeAlmanacPillarObject)

### timeAlmanacDayObject.yi <a id="timeAlmanacDayObject.yi" href="#timeAlmanacDayObject.yi">&#x23;</a>
宜：字符串数组。

### timeAlmanacDayObject.yinNobleDirection <a id="timeAlmanacDayObject.yinNobleDirection" href="#timeAlmanacDayObject.yinNobleDirection">&#x23;</a>
阴贵神方位。

## timeAlmanacHourObject 成员列表 <a id="timeAlmanacHourObject" href="#timeAlmanacHourObject">&#x23;</a>

### timeAlmanacHourObject.datetime <a id="timeAlmanacHourObject.datetime" href="#timeAlmanacHourObject.datetime">&#x23;</a>
公历日期时间字符串。

### timeAlmanacHourObject.day <a id="timeAlmanacHourObject.day" href="#timeAlmanacHourObject.day">&#x23;</a>
时宜忌所用日干支（23点为次日）。  

[返回对象:timeAlmanacPillarObject](#timeAlmanacPillarObject)

### timeAlmanacHourObject.dayOffset <a id="timeAlmanacHourObject.dayOffset" href="#timeAlmanacHourObject.dayOffset">&#x23;</a>
23点为1，其余为0；不改变公历日期。

### timeAlmanacHourObject.ecliptic <a id="timeAlmanacHourObject.ecliptic" href="#timeAlmanacHourObject.ecliptic">&#x23;</a>
黄道或黑道。

### timeAlmanacHourObject.endHour <a id="timeAlmanacHourObject.endHour" href="#timeAlmanacHourObject.endHour">&#x23;</a>
当天时段结束小时，不包含；晚子结束为24。

### timeAlmanacHourObject.hour <a id="timeAlmanacHourObject.hour" href="#timeAlmanacHourObject.hour">&#x23;</a>
时干支。  

[返回对象:timeAlmanacPillarObject](#timeAlmanacPillarObject)

### timeAlmanacHourObject.isLucky <a id="timeAlmanacHourObject.isLucky" href="#timeAlmanacHourObject.isLucky">&#x23;</a>
时值神是否为黄道。

### timeAlmanacHourObject.ji <a id="timeAlmanacHourObject.ji" href="#timeAlmanacHourObject.ji">&#x23;</a>
时忌：字符串数组。

### timeAlmanacHourObject.name <a id="timeAlmanacHourObject.name" href="#timeAlmanacHourObject.name">&#x23;</a>
时辰名称，如子时。

### timeAlmanacHourObject.startHour <a id="timeAlmanacHourObject.startHour" href="#timeAlmanacHourObject.startHour">&#x23;</a>
当天时段起始小时，包含。

### timeAlmanacHourObject.twelveStar <a id="timeAlmanacHourObject.twelveStar" href="#timeAlmanacHourObject.twelveStar">&#x23;</a>
时辰十二值神。

### timeAlmanacHourObject.yi <a id="timeAlmanacHourObject.yi" href="#timeAlmanacHourObject.yi">&#x23;</a>
时宜：字符串数组。

## timeAlmanacPillarObject 成员列表 <a id="timeAlmanacPillarObject" href="#timeAlmanacPillarObject">&#x23;</a>

### timeAlmanacPillarObject.gan <a id="timeAlmanacPillarObject.gan" href="#timeAlmanacPillarObject.gan">&#x23;</a>
天干。

### timeAlmanacPillarObject.ganIndex <a id="timeAlmanacPillarObject.ganIndex" href="#timeAlmanacPillarObject.ganIndex">&#x23;</a>
天干索引（0~9）。

### timeAlmanacPillarObject.index <a id="timeAlmanacPillarObject.index" href="#timeAlmanacPillarObject.index">&#x23;</a>
六十甲子索引（0~59，甲子=0）。

### timeAlmanacPillarObject.name <a id="timeAlmanacPillarObject.name" href="#timeAlmanacPillarObject.name">&#x23;</a>
干支名称。

### timeAlmanacPillarObject.nayin <a id="timeAlmanacPillarObject.nayin" href="#timeAlmanacPillarObject.nayin">&#x23;</a>
纳音。

### timeAlmanacPillarObject.zhi <a id="timeAlmanacPillarObject.zhi" href="#timeAlmanacPillarObject.zhi">&#x23;</a>
地支。

### timeAlmanacPillarObject.zhiIndex <a id="timeAlmanacPillarObject.zhiIndex" href="#timeAlmanacPillarObject.zhiIndex">&#x23;</a>
地支索引（0~11）。
