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

    Type Alias FormatToken

    FormatToken:
        | "CY"
        | "Y"
        | "Ygz"
        | "Z"
        | "M"
        | "Mname"
        | "L"
        | "D"
        | "Dname"
        | "GY"
        | "GYcn"
        | "GYcn2"
        | "GM"
        | "GM0"
        | "GMcn"
        | "GD"
        | "GD0"
        | "GDcn"
        | "W"
        | "Wname"
        | "Wshort"

    Format pattern tokens

    Tokens that can be used in the format function's pattern string.

    Token Output Example
    {CY} Cycle number "78"
    {Y} Year in cycle "34"
    {Ygz} Year GanZhi "甲辰"
    {Z} Zodiac animal "龙" / "龍"
    {M} Lunar month number "7"
    {Mname} Lunar month name "七月"
    {L} Leap indicator "闰" / "閏"
    {D} Lunar day number "28"
    {Dname} Lunar day name "廿八"
    {GY} Gregorian year "2025"
    {GYcn} Gregorian year 〇 "二〇二五"
    {GYcn2} Gregorian year 零 "二零二五"
    {GM} Gregorian month "10"
    {GM0} Gregorian month (padded) "03"
    {GMcn} Gregorian month 中文 "十"
    {GD} Gregorian day "11"
    {GD0} Gregorian day (padded) "01"
    {GDcn} Gregorian day 中文 "十一"
    {W} Weekday number "6"
    {Wname} Weekday full name "星期六"
    {Wshort} Weekday short name "六"