README
¶
Timex
Provides an enhanced time.Time implementation, and add more commonly used functional methods.
Install
go get github.com/gookit/goutil/timex
Timex Usage
Create timex instance
now := timex.Now()
// from time.Time
tx := timex.New(time.Now())
tx := timex.FromTime(time.Now())
// from time unix
tx := timex.FromUnix(1647411580)
Create from datetime string:
// auto match layout by datetime
tx, err := timex.FromString("2022-04-20 19:40:34")
// custom set the datetime layout
tx, err := timex.FromString("2022-04-20 19:40:34", "2006-01-02 15:04:05")
// use date template as layout
tx, err := timex.FromDate("2022-04-20 19:40:34", "Y-m-d H:I:S")
Use timex instance
tx := timex.Now()
Change time:
tx.Yesterday()
tx.Tomorrow()
tx.DayStart() // get time at Y-m-d 00:00:00
tx.DayEnd() // get time at Y-m-d 23:59:59
tx.HourStart() // get time at Y-m-d H:00:00
tx.HourEnd() // get time at Y-m-d H:59:59
tx.AddDay(2)
tx.AddHour(1)
tx.AddMinutes(15)
tx.AddSeconds(120)
Compare time:
// before compare
tx.IsBefore(u time.Time)
tx.IsBeforeUnix(1647411580)
// after compare
tx.IsAfter(u time.Time)
tx.IsAfterUnix(1647411580)
Helper functions
ts := timex.NowUnix() // current unix timestamp
t := NowAddDay(1) // from now add 1 day
t := NowAddHour(1) // from now add 1 hour
t := NowAddMinutes(3) // from now add 3 minutes
t := NowAddSeconds(180) // from now add 180 seconds
Convert time to date by template
Template Chars:
Y,y - year
Y - year 2006
y - year 06
m - month 01-12
d - day 01-31
H,h - hour
H - hour 00-23
h - hour 01-12
I,i - minute
I - minute 00-59
i - minute 0-59
S,s - second
S - second 00-59
s - second 0-59
... ...
More, please see charMap
Examples, use timex format date:
tx := timex.Now()
date := tx.DateFormat("Y-m-d H:I:S") // Output: 2022-04-20 19:09:03
date = tx.DateFormat("y-m-d h:i:s") // Output: 22-04-20 07:9:3
Format time.Time:
tx := time.Now()
date := timex.DateFormat(tx, "Y-m-d H:I:S") // Output: 2022-04-20 19:40:34
More usage:
ts := timex.NowUnix() // current unix timestamp
date := FormatUnix(ts, "2006-01-02 15:04:05") // Get: 2022-04-20 19:40:34
date := FormatUnixByTpl(ts, "Y-m-d H:I:S") // Get: 2022-04-20 19:40:34
Documentation
¶
Overview ¶
Package timex provides an enhanced time.Time implementation. Add more commonly used functional methods.
such as: DayStart(), DayAfter(), DayAgo(), DateFormat() and more.
Index ¶
- Constants
- Variables
- func AddDay(t time.Time, day int) time.Time
- func AddHour(t time.Time, hour int) time.Time
- func AddMinutes(t time.Time, minutes int) time.Time
- func AddSeconds(t time.Time, seconds int) time.Time
- func Date(t time.Time, template string) string
- func DateFormat(t time.Time, template string) string
- func DayEnd(t time.Time) time.Time
- func DayStart(t time.Time) time.Time
- func Format(t time.Time) string
- func FormatBy(t time.Time, layout string) string
- func FormatByTpl(t time.Time, template string) string
- func FormatUnix(sec int64) string
- func FormatUnixBy(sec int64, layout string) string
- func FormatUnixByTpl(sec int64, template string) string
- func HourEnd(t time.Time) time.Time
- func HourStart(t time.Time) time.Time
- func HowLongAgo(sec int64) string
- func NowAddDay(day int) time.Time
- func NowAddHour(hour int) time.Time
- func NowAddMinutes(minutes int) time.Time
- func NowAddSeconds(seconds int) time.Time
- func NowHourEnd() time.Time
- func NowHourStart() time.Time
- func NowUnix() int64
- func SetLocalByName(tzName string) error
- func ToDuration(s string) (time.Duration, error)
- func ToLayout(template string) string
- func TodayEnd() time.Time
- func TodayStart() time.Time
- type TimeX
- func FromDate(s string, template ...string) (*TimeX, error)
- func FromString(s string, layouts ...string) (*TimeX, error)
- func FromTime(t time.Time) *TimeX
- func FromUnix(sec int64) *TimeX
- func Local() *TimeX
- func LocalByName(tzName string) *TimeX
- func New(t time.Time) *TimeX
- func Now() *TimeX
- func Wrap(t time.Time) *TimeX
- func (t *TimeX) AddDay(day int) *TimeX
- func (t *TimeX) AddHour(hours int) *TimeX
- func (t *TimeX) AddMinutes(minutes int) *TimeX
- func (t *TimeX) AddSeconds(seconds int) *TimeX
- func (t *TimeX) CustomHMS(hour, min, sec int) *TimeX
- func (t *TimeX) DateFormat(template string) string
- func (t *TimeX) Datetime() string
- func (t *TimeX) DayAfter(day int) *TimeX
- func (t *TimeX) DayAgo(day int) *TimeX
- func (t *TimeX) DayEnd() *TimeX
- func (t *TimeX) DayStart() *TimeX
- func (t TimeX) Diff(u time.Time) time.Duration
- func (t TimeX) DiffSec(u time.Time) int
- func (t *TimeX) Format(layout string) string
- func (t *TimeX) HourEnd() *TimeX
- func (t *TimeX) HourStart() *TimeX
- func (t TimeX) HowLongAgo(before time.Time) string
- func (t *TimeX) IsAfter(u time.Time) bool
- func (t *TimeX) IsAfterUnix(ux int64) bool
- func (t *TimeX) IsBefore(u time.Time) bool
- func (t *TimeX) IsBeforeUnix(ux int64) bool
- func (t TimeX) SubUnix(u time.Time) int
- func (t TimeX) T() time.Time
- func (t TimeX) Timestamp() int64
- func (t *TimeX) Tomorrow() *TimeX
- func (t *TimeX) TplFormat(template string) string
- func (t *TimeX) Yesterday() *TimeX
Constants ¶
const ( OneSecond = 1 OneMinSec = 60 OneHourSec = 3600 OneDaySec = 86400 OneWeekSec = 7 * 86400 Second = time.Second OneMin = time.Minute OneHour = time.Hour OneDay = 24 * time.Hour OneWeek = 7 * 24 * time.Hour )
provide some commonly time consts
Variables ¶
var (
// DefaultLayout template for format time
DefaultLayout = "2006-01-02 15:04:05"
)
Functions ¶
func AddMinutes ¶
AddMinutes add some minutes time for given time
func AddSeconds ¶
AddSeconds add some seconds time for given time
func DateFormat ¶ added in v0.5.1
DateFormat format time by given date template. see ToLayout()
func FormatByTpl ¶ added in v0.5.1
FormatByTpl format time by given date template. see ToLayout()
func FormatUnixBy ¶
FormatUnixBy format time seconds use given layout
func FormatUnixByTpl ¶ added in v0.5.1
FormatUnixByTpl format time seconds use given date template. see ToLayout()
func HowLongAgo ¶ added in v0.5.1
HowLongAgo format given timestamp to string.
func NowAddMinutes ¶
NowAddMinutes add some minutes time from now
func NowAddSeconds ¶
NowAddSeconds add some seconds time from now
func SetLocalByName ¶
SetLocalByName set local by tz name. eg: UTC, PRC
func ToDuration ¶ added in v0.5.6
ToDuration parses a duration string. such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
Types ¶
type TimeX ¶
type TimeX struct {
time.Time
// Layout set the default date format layout. default use DefaultLayout
Layout string
}
TimeX struct
func FromString ¶ added in v0.5.1
FromString create from datetime string. see strutil.ToTime()
func (*TimeX) AddMinutes ¶
AddMinutes add some minutes time for the time
func (*TimeX) AddSeconds ¶
AddSeconds add some seconds time the time
func (*TimeX) CustomHMS ¶ added in v0.5.2
CustomHMS custom change the hour, minute, second for create new time.
func (*TimeX) DateFormat ¶ added in v0.5.1
DateFormat use input template format time to date. see ToLayout()
func (*TimeX) DayAfter ¶ added in v0.5.1
DayAfter get some day after time for the time. alias of TimeX.AddDay()
func (*TimeX) Format ¶ added in v0.5.1
Format returns a textual representation of the time value formatted according to the layout defined by the argument.
see time.Time.Format()
func (TimeX) HowLongAgo ¶ added in v0.5.1
HowLongAgo format diff time to string.
func (*TimeX) IsAfterUnix ¶ added in v0.5.2
IsAfterUnix the given unix timestamp
func (*TimeX) IsBeforeUnix ¶ added in v0.5.2
IsBeforeUnix the given unix timestamp
Source Files