diff --git a/docs/datetime.md b/docs/datetime.md index f70af0d..593b704 100644 --- a/docs/datetime.md +++ b/docs/datetime.md @@ -22,6 +22,19 @@ import ( - [AddDay](#AddDay) - [AddHour](#AddHour) - [AddMinute](#AddMinute) +- [BeginOfMinute](#BeginOfMinute) +- [BeginOfHour](#BeginOfHour) +- [BeginOfDay](#BeginOfDay) +- [BeginOfWeek](#BeginOfWeek) +- [BeginOfMonth](#BeginOfMonth) +- [BeginOfYear](#BeginOfYear) + +- [EndOfMinute](#EndOfMinute) +- [EndOfHour](#EndOfHour) +- [EndOfDay](#EndOfDay) +- [EndOfWeek](#BeginOfWeek) +- [EndOfMonth](#BeginOfMonth) +- [EndOfYear](#BeginOfYear) - [GetNowDate](#GetNowDate) - [GetNowTime](#GetNowTime) - [GetNowDateTime](#GetNowDateTime) @@ -142,6 +155,331 @@ func main() { } ``` +### BeginOfMinute +

Return beginning minute time of day.

+ +Signature: + +```go +func BeginOfMinute(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfMinute(td) + fmt.Println(bm) //2022-02-15 15:48:00 +0800 CST +} +``` + +### BeginOfHour +

Return zero time of day.

+ +Signature: + +```go +func BeginOfHour(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfHour(td) + fmt.Println(bm) //2022-02-15 15:00:00 +0800 CST +} +``` + +### BeginOfDay +

Return begin time of day.

+ +Signature: + +```go +func BeginOfDay(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfDay(td) + fmt.Println(bm) //2022-02-15 00:00:00 +0800 CST +} +``` + + + +### BeginOfWeek +

Return beginning time of week, week begin from Sunday.

+ +Signature: + +```go +func BeginOfWeek(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfWeek(td) + fmt.Println(bm) //2022-02-13 00:00:00 +0800 CST +} +``` + + + +### BeginOfWeek +

Return beginning time of month

+ +Signature: + +```go +func BeginOfMonth(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfMonth(td) + fmt.Println(bm) //2022-02-01 00:00:00 +0800 CST +} +``` + + +### BeginOfYear +

Return beginning time of year.

+ +Signature: + +```go +func BeginOfYear(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfYear(td) + fmt.Println(bm) //2022-01-01 00:00:00 +0800 CST +} +``` + + + +### EndOfMinute +

Return end time minute of day.

+ +Signature: + +```go +func EndOfMinute(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfMinute(td) + fmt.Println(bm) //2022-02-15 15:48:59.999999999 +0800 CST +} +``` + +### EndOfHour +

Return end time hour of day.

+ +Signature: + +```go +func EndOfHour(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfHour(td) + fmt.Println(bm) //2022-02-15 15:59:59.999999999 +0800 CST +} +``` + +### EndOfDay +

Return end time hour of day.

+ +Signature: + +```go +func EndOfDay(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfDay(td) + fmt.Println(bm) //2022-02-15 23:59:59.999999999 +0800 CST +} +``` + + + +### EndOfWeek +

Return end time of week, week end with Saturday.

+ +Signature: + +```go +func EndOfWeek(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfWeek(td) + fmt.Println(bm) //2022-02-19 23:59:59.999999999 +0800 CST +} +``` + + + +### EndOfMonth +

Return end time of month

+ +Signature: + +```go +func EndOfMonth(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfMonth(td) + fmt.Println(bm) //2022-02-28 23:59:59.999999999 +0800 CST +} +``` + + +### EndOfYear +

Return beginning time of year.

+ +Signature: + +```go +func EndOfYear(t time.Time) time.Time +``` +Example: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfYear(td) + fmt.Println(bm) //2022-12-31 23:59:59.999999999 +0800 CST +} +``` + + ### GetNowDate

Get current date string, format is yyyy-mm-dd.

diff --git a/docs/datetime_zh-CN.md b/docs/datetime_zh-CN.md index cc5a4af..c98bebb 100644 --- a/docs/datetime_zh-CN.md +++ b/docs/datetime_zh-CN.md @@ -142,6 +142,331 @@ func main() { } ``` +### BeginOfMinute +

返回指定时间的分钟开始时间

+ +函数签名: + +```go +func BeginOfMinute(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfMinute(td) + fmt.Println(bm) //2022-02-15 15:48:00 +0800 CST +} +``` + +### BeginOfHour +

返回指定时间的小时开始时间

+ +函数签名: + +```go +func BeginOfHour(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfHour(td) + fmt.Println(bm) //2022-02-15 15:00:00 +0800 CST +} +``` + +### BeginOfDay +

返回指定时间的当天开始时间

+ +函数签名: + +```go +func BeginOfDay(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfDay(td) + fmt.Println(bm) //2022-02-15 00:00:00 +0800 CST +} +``` + + + +### BeginOfWeek +

返回指定时间的星期开始时间

+ +函数签名: + +```go +func BeginOfWeek(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfWeek(td) + fmt.Println(bm) //2022-02-13 00:00:00 +0800 CST +} +``` + + + +### BeginOfWeek +

返回指定时间的当月开始时间

+ +函数签名: + +```go +func BeginOfMonth(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfMonth(td) + fmt.Println(bm) //2022-02-01 00:00:00 +0800 CST +} +``` + + +### BeginOfYear +

返回指定时间的当年开始时间

+ +函数签名: + +```go +func BeginOfYear(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.BeginOfYear(td) + fmt.Println(bm) //2022-01-01 00:00:00 +0800 CST +} +``` + + + +### EndOfMinute +

返回指定时间的分钟结束时间

+ +函数签名: + +```go +func EndOfMinute(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfMinute(td) + fmt.Println(bm) //2022-02-15 15:48:59.999999999 +0800 CST +} +``` + +### EndOfHour +

返回指定时间的小时结束时间

+ +函数签名: + +```go +func EndOfHour(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfHour(td) + fmt.Println(bm) //2022-02-15 15:59:59.999999999 +0800 CST +} +``` + +### EndOfDay +

返回指定时间的当天结束时间.

+ +函数签名: + +```go +func EndOfDay(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfDay(td) + fmt.Println(bm) //2022-02-15 23:59:59.999999999 +0800 CST +} +``` + + + +### EndOfWeek +

返回指定时间的星期结束时间

+ +函数签名: + +```go +func EndOfWeek(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfWeek(td) + fmt.Println(bm) //2022-02-19 23:59:59.999999999 +0800 CST +} +``` + + + +### EndOfMonth +

返回指定时间的月份结束时间

+ +函数签名: + +```go +func EndOfMonth(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfMonth(td) + fmt.Println(bm) //2022-02-28 23:59:59.999999999 +0800 CST +} +``` + + +### EndOfYear +

返回指定时间的年份结束时间

+ +函数签名: + +```go +func EndOfYear(t time.Time) time.Time +``` +例子: + +```go +package main + +import ( + "fmt" + "time" + "github.com/duke-git/lancet/datetime" +) + +func main() { + td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) + bm := datetime.EndOfYear(td) + fmt.Println(bm) //2022-12-31 23:59:59.999999999 +0800 CST +} +``` + + ### GetNowDate

获取当天日期,返回格式:yyyy-mm-dd