chinese-lunar-date API - v1.0.5
    Preparing search index...

    Function zodiac

    Chinese zodiac animal signs. Locale-aware: returns different names for zh-CN ("龙"), zh-TW ("龍"), ja-JP ("辰"), ko-KR ("진"), vi-VN ("Thìn").

    • Get zodiac animal name from a lunar date

      Returns the localized zodiac animal name. Key differences between locales:

      • zh-CN uses simplified characters: 龙, 马, 鸡, 猪
      • zh-TW/zh-HK use traditional characters: 龍, 馬, 雞, 豬
      • ja-JP uses the branch character itself: 子, 丑, 寅...
      • ko-KR uses Hangul: 자, 축, 인...
      • vi-VN uses Vietnamese: Tý, Sửu, Dần...

      Parameters

      • value: LunarDateValue

        Lunar date value

      • locale: string = 'zh-CN'

        Locale code (default: 'zh-CN')

      Returns string

      Localized zodiac animal name

      zodiac(value, 'zh-CN')  // "龙"
      zodiac(value, 'zh-TW')  // "龍"
      zodiac(value, 'zh-HK')  // "龍"
      zodiac(value, 'ja-JP')  // "辰"

    Settings

    Member Visibility