diff --git a/datetime/datetime.go b/datetime/datetime.go index b05ba37..d046a94 100644 --- a/datetime/datetime.go +++ b/datetime/datetime.go @@ -248,6 +248,8 @@ func DayOfYear(t time.Time) int { return int(nowDate.Sub(firstDay).Hours() / 24) } -func IsWeekend(t1 time.Time) bool { - return time.Saturday == t1.Weekday() || time.Sunday == t1.Weekday() +// IsWeekend checks if passed time is weekend or not. +// Play: todo +func IsWeekend(t time.Time) bool { + return time.Saturday == t.Weekday() || time.Sunday == t.Weekday() } diff --git a/datetime/datetime_example_test.go b/datetime/datetime_example_test.go index e835c70..0522304 100644 --- a/datetime/datetime_example_test.go +++ b/datetime/datetime_example_test.go @@ -389,3 +389,22 @@ func ExampleDayOfYear() { // 1 // 0 } + +func ExampleIsWeekend() { + date1 := time.Date(2023, 06, 03, 0, 0, 0, 0, time.Local) + date2 := time.Date(2023, 06, 04, 0, 0, 0, 0, time.Local) + date3 := time.Date(2023, 06, 02, 0, 0, 0, 0, time.Local) + + result1 := IsWeekend(date1) + result2 := IsWeekend(date2) + result3 := IsWeekend(date3) + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + + // Output: + // true + // true + // false +} diff --git a/docs/datetime.md b/docs/datetime.md index 08d6f4d..ea68f63 100644 --- a/docs/datetime.md +++ b/docs/datetime.md @@ -57,6 +57,7 @@ import ( - [IsLeapYear](#IsLeapYear) - [BetweenSeconds](#BetweenSeconds) - [DayOfYear](#DayOfYear) +- [IsWeekend](#IsWeekend)
@@ -1218,3 +1219,44 @@ func main() { // 0 } ``` + + +### IsWeekend + +

Checks if passed time is weekend or not.

+ +Signature: + +```go +func IsWeekend(t time.Time) bool +``` + +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/datetime" +) + +func main() { + date1 := time.Date(2023, 06, 03, 0, 0, 0, 0, time.Local) + date2 := time.Date(2023, 06, 04, 0, 0, 0, 0, time.Local) + date3 := time.Date(2023, 06, 02, 0, 0, 0, 0, time.Local) + + result1 := datetime.IsWeekend(date1) + result2 := datetime.IsWeekend(date2) + result3 := datetime.IsWeekend(date3) + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + + // Output: + // true + // true + // false +} +``` diff --git a/docs/datetime_zh-CN.md b/docs/datetime_zh-CN.md index 1cb33a8..54a69f6 100644 --- a/docs/datetime_zh-CN.md +++ b/docs/datetime_zh-CN.md @@ -56,6 +56,7 @@ import ( - [IsLeapYear](#IsLeapYear) - [BetweenSeconds](#BetweenSeconds) - [DayOfYear](#DayOfYear) +- [IsWeekend](#IsWeekend)
@@ -1216,3 +1217,43 @@ func main() { // 0 } ``` + +### IsWeekend + +

判断日期是否是周末。

+ +函数签名: + +```go +func IsWeekend(t time.Time) bool +``` + +示例: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/datetime" +) + +func main() { + date1 := time.Date(2023, 06, 03, 0, 0, 0, 0, time.Local) + date2 := time.Date(2023, 06, 04, 0, 0, 0, 0, time.Local) + date3 := time.Date(2023, 06, 02, 0, 0, 0, 0, time.Local) + + result1 := datetime.IsWeekend(date1) + result2 := datetime.IsWeekend(date2) + result3 := datetime.IsWeekend(date3) + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + + // Output: + // true + // true + // false +} +```