{"id":27290921,"url":"https://github.com/kabeep/zodiac-animals","last_synced_at":"2026-02-18T19:01:47.942Z","repository":{"id":263255529,"uuid":"889811828","full_name":"kabeep/zodiac-animals","owner":"kabeep","description":"🐼 A JavaScript zodiac animals utility library.","archived":false,"fork":false,"pushed_at":"2025-02-24T19:18:35.000Z","size":91,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-26T01:20:45.225Z","etag":null,"topics":["animal","browser","lunar","nodejs","utility","zodiac"],"latest_commit_sha":null,"homepage":"https://kabeep.github.io/zodiac-animals/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kabeep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-17T09:55:40.000Z","updated_at":"2024-11-29T14:41:46.000Z","dependencies_parsed_at":"2025-06-04T16:07:29.739Z","dependency_job_id":"1a005b42-eeab-4c50-ba42-e1a72fdcb6e6","html_url":"https://github.com/kabeep/zodiac-animals","commit_stats":null,"previous_names":["kabeep/zodiac-animals"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/kabeep/zodiac-animals","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fzodiac-animals","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fzodiac-animals/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fzodiac-animals/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fzodiac-animals/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kabeep","download_url":"https://codeload.github.com/kabeep/zodiac-animals/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fzodiac-animals/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29590683,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T18:54:29.675Z","status":"ssl_error","status_checked_at":"2026-02-18T18:50:50.517Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animal","browser","lunar","nodejs","utility","zodiac"],"created_at":"2025-04-11T21:39:36.054Z","updated_at":"2026-02-18T19:01:47.936Z","avatar_url":"https://github.com/kabeep.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ch1\u003ezodiac-animals\u003c/h1\u003e\n\n🐼 A JavaScript zodiac animals utility library\n\n[![NodeJS][node-image]][node-url]\n[![License][license-image]][license-url]\n[![NPM][npm-image]][npm-url]\n[![Codecov][codecov-image]][codecov-url]\n[![Codacy Badge][codacy-image]][codacy-url]\n[![CircleCI][circleci-image]][circleci-url]\n\nEnglish | [简体中文][zh-cn-url]\n\n![Insights][insights-url]\n\n\u003c/div\u003e\n\n## 📖 Introduction\n\n\u003e Considering tree-shaking and the rigor required due to cultural differences,\n\u003e the output will exclude i18n content.\n\nA lite utility library using Lunar Calendar.\n\nSee [documentation][docs-url].\n\n## ⚙️ Installation\n\n```bash\nnpm install @kabeep/zodiac-animals --save\n```\n\n```bash\nyarn add @kabeep/zodiac-animals\n```\n\n```bash\npnpm add @kabeep/zodiac-animals\n```\n\n## 🚀 Usage\n\n#### CommonJS\n\n```typescript\nconst { ANIMALS, zodiac, Zodiac: IZodiac } = require('@kabeep/zodiac-animals');\n```\n\n#### ESModule\n\n```typescript\nimport { ANIMALS, zodiac, type Zodiac } from '@kabeep/zodiac-animals';\n```\n\n---\n\n#### Methods: `zodiac(date)`\n\n```typescript\nzodiac(new Date()) as Zodiac;\n```\n\n| Parameter | Type   | Optional | Default | Description                       |\n|-----------|--------|:--------:|---------|-----------------------------------|\n| `date`    | `Date` |    No    | -       | Date Object of Gregorian Calendar |\n\n#### Returns: `interface Zodiac`\n\n**Result Object:**\n\n| Key           | Type       | Required  | Description                                                                                       |\n|---------------|------------|:---------:|---------------------------------------------------------------------------------------------------|\n| `name`        | `string`   |   true    | Zodiac Animal Name                                                                                |\n| `mate`        | `string[]` |   true    | Zodiac Animal Mates                                                                               |\n| `traits`      | `string[]` |   true    | Zodiac Animal Traits                                                                              |\n| `alias`       | `string`   | **false** | Zodiac Animal i18n Alias                                                                          |\n| `year`        | `number`   |   true    | Lunar Year of Date Input                                                                          |\n| `month`       | `number`   |   true    | Lunar Month of Date Input                                                                         |\n| `day`         | `number`   |   true    | Lunar Day of Date Input                                                                           |\n| `isLeapMonth` | `boolean`  |   true    | Lunar Leap Month Flag of Date Input                                                               |\n| `from`        | `Date`     |   true    | Gregorian Date of the First Day of the Lunar Year (Return an Invalid Date if an Exception Occurs) |\n| `to`          | `Date`     |   true    | Gregorian Date of the Last Day of the Lunar Year (Return an Invalid Date if an Exception Occurs)  |\n\n## 🔗 Related\n\n- [lunar-date-fns][lunar-date-fns-url] - 🗓️ A JavaScript lunar date utility library.\n- [lunar-birthday-cli][lunar-birthday-cli-url] - 🎂 A Node.js Library to list the lunar birthday in terminal.\n\n## 🏅 Credits\n\n- [zodiacAnimals2][credits-url] - Reference is made to data design of this repository.\n\n## 🤝 Contribution\n\nContributions via Pull Requests or [Issues][issues-url] are welcome.\n\n## 📄 License\n\nThis project is licensed under the MIT License. See the [LICENSE][license-url] file for details.\n\n\n[node-image]: https://img.shields.io/node/v/%40kabeep%2Fzodiac-animals?color=lightseagreen\n[node-url]: https://nodejs.org/docs/latest/api/\n\n[npm-image]: https://img.shields.io/npm/d18m/%40kabeep%2Fzodiac-animals?color=cornflowerblue\n[npm-url]: https://www.npmjs.com/package/@kabeep/zodiac-animals\n\n[codecov-image]: https://codecov.io/gh/kabeep/zodiac-animals/graph/badge.svg?token=SN18SFJw3N\n[codecov-url]: https://codecov.io/gh/kabeep/zodiac-animals\n\n[codacy-image]: https://app.codacy.com/project/badge/Grade/f9ecd4622c104d4eb0d6f1a5e289e8fe\n[codacy-url]: https://app.codacy.com/gh/kabeep/zodiac-animals/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade\n\n[circleci-image]: https://dl.circleci.com/status-badge/img/gh/kabeep/zodiac-animals/tree/master.svg?style=shield\n[circleci-url]: https://dl.circleci.com/status-badge/redirect/gh/kabeep/zodiac-animals/tree/master\n\n[insights-url]: https://repobeats.axiom.co/api/embed/587b7e5e404afd72869d684be271f8ca28f350ef.svg \"Repobeats analytics image\"\n\n[docs-url]: https://kabeep.github.io/zodiac-animals\n[issues-url]: https://github.com/kabeep/zodiac-animals/issues\n\n[license-image]: https://img.shields.io/github/license/kabeep/zodiac-animals?color=slateblue\n[license-url]: LICENSE\n\n[en-us-url]: README.md\n[zh-cn-url]: README.zh-CN.md\n\n[lunar-date-fns-url]: https://github.com/kabeep/lunar-date-fns\n[lunar-birthday-cli-url]: https://github.com/kabeep/lunar-birthday-cli\n[credits-url]: https://github.com/davisnatalie/zodiacAnimals2\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabeep%2Fzodiac-animals","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkabeep%2Fzodiac-animals","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabeep%2Fzodiac-animals/lists"}