README
¶
Chinese Lunar
Usage and example
Currently only
200years from1900to2100are supported
Gregorian calendar to Lunar calendar// Get Lunar year of animal
carbon.Parse("2020-08-05 13:14:15").Lunar().Animal() // 鼠
// Get lunar festival
carbon.Parse("2021-02-12 13:14:15").Lunar().Festival() // 春节
// Get lunar year
carbon.Parse("2020-08-05 13:14:15").Lunar().Year() // 2020
// Get lunar month
carbon.Parse("2020-08-05 13:14:15").Lunar().Month() // 6
// Get lunar leap month
carbon.Parse("2020-08-05 13:14:15").Lunar().LeapMonth() // 4
// Get lunar day
carbon.Parse("2020-08-05 13:14:15").Lunar().Day() // 16
// Get lunar hour
carbon.Parse("2020-08-05 13:14:15").Lunar().Hour() // 13
// Get lunar minute
carbon.Parse("2020-08-05 13:14:15").Lunar().Minute() // 14
// Get lunar second
carbon.Parse("2020-08-05 13:14:15").Lunar().Second() // 15
// Get lunar date and time string
carbon.Parse("2020-08-05 13:14:15").Lunar().String() // 2020-06-16 13:14:15
fmt.Printf("%s", carbon.Parse("2020-08-05 13:14:15").Lunar()) // 2020-06-16 13:14:15
// Get lunar year as string
carbon.Parse("2020-08-05 13:14:15").Lunar().ToYearString() // 二零二零
// Get lunar month as string
carbon.Parse("2020-08-05 13:14:15").Lunar().ToMonthString() // 六月
// Get lunar leap month as string
carbon.Parse("2020-04-23 13:14:15").Lunar().ToMonthString() // 闰四月
// Get lunar week as string
carbon.Parse("2020-04-23 13:14:15").Lunar().ToWeekString() // 周四
// Get lunar day as string
carbon.Parse("2020-08-05 13:14:15").Lunar().ToDayString() // 十六
// Get lunar date as string
carbon.Parse("2020-08-05 13:14:15").Lunar().ToDateString() // 二零二零年六月十六
// Whether is a lunar zero time
carbon.Parse("0000-00-00 00:00:00").Lunar().IsZero() // true
carbon.Parse("2020-08-05 13:14:15").Lunar().IsZero() // false
// Whether is a lunar leap year
carbon.Parse("2020-08-05 13:14:15").Lunar().IsLeapYear() // true
// Whether is a lunar leap month
carbon.Parse("2020-08-05 13:14:15").Lunar().IsLeapMonth() // false
// Whether is a lunar year of the rat
carbon.Parse("2020-08-05 13:14:15").Lunar().IsRatYear() // true
// Whether is a lunar year of the ox
carbon.Parse("2020-08-05 13:14:15").Lunar().IsOxYear() // false
// Whether is a lunar year of the tiger
carbon.Parse("2020-08-05 13:14:15").Lunar().IsTigerYear() // false
// Whether is a lunar year of the rabbit
carbon.Parse("2020-08-05 13:14:15").Lunar().IsRabbitYear() // false
// Whether is a lunar year of the dragon
carbon.Parse("2020-08-05 13:14:15").Lunar().IsDragonYear() // false
// Whether is a lunar year of the snake
carbon.Parse("2020-08-05 13:14:15").Lunar().IsSnakeYear() // false
// Whether is a lunar year of the horse
carbon.Parse("2020-08-05 13:14:15").Lunar().IsHorseYear() // false
// Whether is a lunar year of the goat
carbon.Parse("2020-08-05 13:14:15").Lunar().IsGoatYear() // false
// Whether is a lunar year of the monkey
carbon.Parse("2020-08-05 13:14:15").Lunar().IsMonkeyYear() // false
// Whether is a lunar year of the rooster
carbon.Parse("2020-08-05 13:14:15").Lunar().IsRoosterYear() // false
// Whether is a lunar year of the dog
carbon.Parse("2020-08-05 13:14:15").Lunar().IsDogYear() // false
// Whether is a lunar year of the dig
carbon.Parse("2020-08-05 13:14:15").Lunar().IsPigYear() // false
Lunar calendar to Gregorian calendar// Convert the Lunar Calendar December 11, 2023 to the gregorian calendar
carbon.CreateFromLunar(2023, 12, 11, 0, 0, 0, false).ToDateTimeString() // 2024-01-21 00:00:00
// Convert lunar calendar February 11, 2023 to gregorian calendar
carbon.CreateFromLunar(2023, 2, 11, 0, 0, 0, false).ToDateTimeString() // 2024-03-02 00:00:00
// Convert the Lunar Calendar Leap February 11, 2024 to the gregorian calendar
carbon.CreateFromLunar(2023, 2, 11, 0, 0, 0, true).ToDateTimeString() // 2023-04-01 00:00:00
Documentation
¶
Overview ¶
Package lunar is part of the carbon package.
Index ¶
- type Gregorian
- type Lunar
- func (l Lunar) Animal() string
- func (l Lunar) Day() int
- func (l Lunar) Festival() string
- func (l Lunar) Hour() int
- func (l Lunar) IsDogYear() bool
- func (l Lunar) IsDragonYear() bool
- func (l Lunar) IsGoatYear() bool
- func (l Lunar) IsHorseYear() bool
- func (l Lunar) IsLeapMonth() bool
- func (l Lunar) IsLeapYear() bool
- func (l Lunar) IsMonkeyYear() bool
- func (l Lunar) IsOxYear() bool
- func (l Lunar) IsPigYear() bool
- func (l Lunar) IsRabbitYear() bool
- func (l Lunar) IsRatYear() bool
- func (l Lunar) IsRoosterYear() bool
- func (l Lunar) IsSnakeYear() bool
- func (l Lunar) IsTigerYear() bool
- func (l Lunar) IsZero() bool
- func (l Lunar) LeapMonth() int
- func (l Lunar) Minute() int
- func (l Lunar) Month() int
- func (l Lunar) Second() int
- func (l Lunar) String() string
- func (l Lunar) ToDateString() string
- func (l Lunar) ToDayString() (day string)
- func (l Lunar) ToGregorian() (g Gregorian)
- func (l Lunar) ToMonthString() (month string)
- func (l Lunar) ToWeekString() (month string)
- func (l Lunar) ToYearString() (year string)
- func (l Lunar) Year() int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Gregorian ¶ added in v2.3.7
Gregorian defines a Gregorian struct. 定义 Gregorian 结构体
func FromGregorian ¶ added in v2.3.8
FromGregorian creates a Gregorian instance from time.Time. 从标准 time.Time 创建 Gregorian 实例
type Lunar ¶
type Lunar struct {
Error error
// contains filtered or unexported fields
}
Lunar defines a Lunar struct. 定义 Lunar 结构体
func FromLunar ¶ added in v2.3.8
FromLunar creates a Lunar instance from lunar datetime. 从 农历日期 创建 Lunar 实例
func (Lunar) IsDragonYear ¶ added in v2.3.7
IsDragonYear reports whether is year of Dragon. 是否是龙年
func (Lunar) IsGoatYear ¶ added in v2.3.7
IsGoatYear reports whether is year of Goat. 是否是羊年
func (Lunar) IsHorseYear ¶ added in v2.3.7
IsHorseYear reports whether is year of Horse. 是否是马年
func (Lunar) IsLeapMonth ¶ added in v2.3.7
IsLeapMonth reports whether is leap month. 是否是农历闰月
func (Lunar) IsLeapYear ¶ added in v2.3.7
IsLeapYear reports whether is leap year. 是否是农历闰年
func (Lunar) IsMonkeyYear ¶ added in v2.3.7
IsMonkeyYear reports whether is year of Monkey. 是否是猴年
func (Lunar) IsRabbitYear ¶ added in v2.3.7
IsRabbitYear reports whether is year of Rabbit. 是否是兔年
func (Lunar) IsRoosterYear ¶ added in v2.3.7
IsRoosterYear reports whether is year of Rooster. 是否是鸡年
func (Lunar) IsSnakeYear ¶ added in v2.3.7
IsSnakeYear reports whether is year of Snake. 是否是蛇年
func (Lunar) IsTigerYear ¶ added in v2.3.7
IsTigerYear reports whether is year of Tiger. 是否是虎年
func (Lunar) String ¶ added in v2.3.7
String implements Stringer interface and outputs a string in YYYY-MM-DD HH::ii::ss format like "2019-12-07 00:00:00". 实现 Stringer 接口, 输出 YYYY-MM-DD HH::ii::ss 格式字符串，如 "2019-12-07 00:00:00"
func (Lunar) ToDateString ¶ added in v2.3.7
ToDateString outputs a string in lunar date format like "二零二零年腊月初五". 获取农历日期字符串，如 "二零二零年腊月初五"
func (Lunar) ToDayString ¶ added in v2.3.7
ToDayString outputs a string in lunar day format like "廿一". 获取农历日字符串，如 "廿一"
func (Lunar) ToGregorian ¶ added in v2.3.7
ToGregorian converts Lunar instance to Gregorian instance. 将 Lunar 实例转化为 Gregorian 实例
func (Lunar) ToMonthString ¶ added in v2.3.7
ToMonthString outputs a string in lunar month format like "正月". 获取农历月份字符串，如 "正月"
func (Lunar) ToWeekString ¶ added in v2.3.8
ToWeekString outputs a string in week layout like "周一". 输出完整农历星期字符串，如 "周一"
func (Lunar) ToYearString ¶ added in v2.3.7
ToYearString outputs a string in lunar year format like "二零二零". 获取农历年份字符串，如 "二零二零"
Source Files