📖 简介

考虑到树摇和文化差异所需的严谨性，不会输出国际化内容。

一个使用农历轻量的生肖实用程序库。

查看文档。

⚙️ 安装

npm install @kabeep/zodiac-animals --save
Copy

yarn add @kabeep/zodiac-animals
Copy

pnpm add @kabeep/zodiac-animals
Copy

🚀 使用

CommonJS

const { ANIMALS, zodiac, Zodiac } = require('@kabeep/zodiac-animals');
Copy

ESModule

import { ANIMALS, zodiac, type Zodiac } from '@kabeep/zodiac-animals';
Copy

---

函数: zodiac(date)

zodiac(new Date()) as Zodiac;
Copy

参数	类型	可选	默认值	描述
date	Date	No	-	公历日期对象

返回: interface Zodiac

Result Object:

属性	类型	必选	描述
name	string	true	生肖名称
mate	string[]	true	生肖配对
traits	string[]	true	生肖特征
alias	string	false	生肖别名（文化差异）
year	number	true	输入日期的农历年
month	number	true	输入日期的农历月
day	number	true	输入日期的农历日
isLeapMonth	boolean	true	输入日期是否是闰月
from	Date	true	农历年第一天的公历日期（发生错误时返回一个 Invalid Date）
to	Date	true	农历年最后一天的公历日期（发生错误时返回一个 Invalid Date）

🔗 关联库

• lunar-date-fns - 🗓️ 一个 JavaScript 农历日期的实用程序库。
• lunar-birthday-cli - 🎂 在终端中列出农历诞辰的 Node.js 库。

🏅 致谢

• zodiacAnimals2 - 参考了这个存储库的数据设计。

🤝 贡献

欢迎通过 Pull Requests 或 Issues 来贡献你的想法和代码。

📄 许可

本项目采用 MIT 许可证。详情请见 LICENSE 文件。