goment

package module
v1.0.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 4, 2020 License: MIT Imports: 9 Imported by: 54

README

Go

Goment

Goment is a port of the popular Javascript datetime library Moment.js. It follows the Moment.js API closely, with some changes to make it more Go-like (e.g. using nanoseconds instead of milliseconds).

Goment is still a work in progress. Please feel free to fork and contribute missing methods, locale/languages functionality, or just provide more idiomatic Go if you see some areas to improve. I have a list of things that need added/fixed in TODO.md, but will create issues for them at some point.

Features

Parsing
From now

Creates a Goment object for the current local time returned by time.Now().

goment.New()
From ISO 8601 string

Creates a Goment object by parsing the string as an ISO 8601 date time. The timezone will be UTC unless supplied in the string.

goment.New('2013-02-08 09:30:26')
From string + format

Creates a Goment object by parsing the string using the supplied format. The timezone will be the local timezone unless supplied in the string.

The parsing tokens are similar to the formatting tokens used in Goment#Format.

Supported tokens
Token Output
Month M 1 2 ... 11 12
MM 01 01 ... 11 12
MMM Jan Feb ... Nov Dec
MMMM January February ... November December
Day of Month D 1 2 ... 30 31
Do 1st 2nd ... 30th 31st
DD 01 02 ... 30 31
Day of Year DDD 1 2 ... 364 365
DDDD 001 002 ... 364 365
Year YY 70 71 ... 29 30
YYYY 1970 1971 ... 2029 2030
Y -25
Quarter Q 1 2 3 4
AM/PM A AM PM
a am pm
Hour H 0 1 ... 22 23
HH 00 01 ... 22 23
h 1 2 ... 11 12
hh 01 02 ... 11 12
k 1 2 ... 23 24
kk 01 02 ... 23 24
Minute m 0 1 ... 58 59
mm 00 01 ... 58 59
Second s 0 1 ... 58 59
ss 00 01 ... 58 59
Time Zone Z -07:00 -06:00 ... +06:00 +07:00
ZZ -0700 -0600 ... +0600 +0700
Unix Timestamp X 1360013296 
goment.New("12-25-1995", "MM-DD-YYYY")
From Unix nanoseconds

Creates a Goment object from the Unix nanoseconds since the Unix Epoch.

goment.New(time.Now().UnixNano())
From Unix seconds

Creates a Goment object from the Unix timestamp (seconds since the Unix Epoch).

goment.Unix(1318781876)
From Go Time object

Creates a Goment object from the supplied Go time object.

goment.New(time.Date(2015, 11, 10, 5, 30, 0, 0, time.UTC))
From a Goment clone

Creates a Goment object from a clone of the supplied Goment object.

goment.New(goment.New('2011-05-08'))
From Goment DateTime object

Creates a Goment object from a Goment DateTime object.

goment.New(DateTime{
    Year:  2015,
    Month: 1,
    Day:   25,
    Hour:  10,
})
Get+Set
Get

Get is a string getter using the supplied units.

Supported units
  • y, year, years
  • M, month, months
  • D, date, dates
  • h, hour, hours
  • m, minute, minutes
  • s, second, seconds
  • ms, millisecond, milliseconds
  • ns, nanosecond, nanoseconds
g.Get('hours')
Nanosecond

Get the nanoseconds of the Goment object.

g.Nanosecond()
Millisecond

Get the milliseconds of the Goment object.

g.Millisecond()
Second

Get the seconds of the Goment object.

g.Second()
Minute

Get the minutes of the Goment object.

g.Minute()
Hour

Get the hours of the Goment object.

g.Hour()
Date

Get the day of the month of the Goment object.

g.Date()
Day

Get the day of the week (Sunday = 0...) of the Goment object.

g.Day()
ISOWeekday

Gets the Goment object ISO day of the week with 1 being Monday and 7 being Sunday.

g.ISOWeekday()
DayOfYear

Gets the day of the year of the Goment object.

g.DayOfYear()
ISOWeek

Gets the ISO week of the year of the Goment object.

g.ISOWeek()
Month

Gets the month (January = 1...) of the Goment object.

g.Month()
Quarter

Gets the quarter (1 to 4) of the Goment object.

g.Quarter()
Year

Gets the year of the Goment object.

g.Year()
ISOWeekYear

Gets the ISO week-year of the Goment object.

g.ISOWeekYear()
Set

Set is a generic setter, accepting units as the first argument, and value as the second.

Supported units
  • y, year, years
  • M, month, months
  • D, date, dates
  • h, hour, hours
  • m, minute, minutes
  • s, second, seconds
  • ms, millisecond, milliseconds
  • ns, nanosecond, nanoseconds
g.Set(6, 'hour')
SetNanosecond

Set the nanoseconds for the Goment object.

g.SetNanosecond(60000)
SetMillisecond

Set the milliseconds for the Goment object.

g.SetMillisecond(5000)
SetSecond

Set the seconds for the Goment object.

g.SetSecond(55)
SetMinute

Set the minutes for the Goment object.

g.SetMinute(15)
SetHour

Set the hours for the Goment object.

g.SetHour(5)
SetDate

Set the day of the month for the Goment object. If the date passed in is greater than the number of days in the month, then the day is set to the last day of the month.

g.SetDate(21)
SetDay

Set the day of the week (Sunday = 0...) for the Goment object.

g.SetDay(1)
SetISOWeekday

Sets the Goment object ISO day of the week with 1 being Monday and 7 being Sunday.

g.SetISOWeekday(2)
SetDayOfYear

Sets the day of the year for the Goment object. For non-leap years, 366 is treated as 365.

g.SetDayOfYear(100)
SetMonth

Sets the month (January = 1...) of the Goment object. If new month has less days than current month, the date is pinned to the end of the target month.

g.SetMonth(3)
SetQuarter

Sets the quarter (1 to 4) for the Goment object.

g.SetQuarter(2)
SetYear

Sets the year for the Goment object.

g.SetYear(2010)
Manipulate
Add

Add mutates the Goment object by adding time. The first argument can either be a time.Duration, or an integer representing the number of the unit to add. The second argument should be a unit.

Supported units
  • y, year, years
  • Q, quarter, quarters
  • M, month, months
  • w, week, weeks
  • d, day, days
  • h, hour, hours
  • m, minute, minutes
  • s, second, seconds
  • ms, millisecond, milliseconds
  • ns, nanosecond, nanoseconds
g.Add(1, 'days')
Subtract

Subtract mutates the Goment object by subtracting time. The first argument can either be a time.Duration, or an integer representing the number of the unit to add. The second argument should be a unit.

Supported units
  • y, year, years
  • Q, quarter, quarters
  • M, month, months
  • w, week, weeks
  • d, day, days
  • h, hour, hours
  • m, minute, minutes
  • s, second, seconds
  • ms, millisecond, milliseconds
  • ns, nanosecond, nanoseconds
g.Subtract(5, 'hours')
StartOf

StartOf mutates the Goment object by setting it to the start of a unit of time.

Supported units
  • y, year, years
  • Q, quarter, quarters
  • M, month, months
  • w, week, weeks
  • W, isoWeek, isoWeeks
  • d, day, days
  • h, hour, hours
  • m, minute, minutes
  • s, second, seconds
g.StartOf('day')
EndOf

EndOf mutates the Goment object by setting it to the end of a unit of time.

Supported units
  • y, year, years
  • Q, quarter, quarters
  • M, month, months
  • w, week, weeks
  • W, isoWeek, isoWeeks
  • d, day, days
  • h, hour, hours
  • m, minute, minutes
  • s, second, seconds
g.EndOf('month')
Local

Local will set the Goment to use local time.

g.Local()
UTC

UTC will set the Goment to use UTC time.

g.UTC()
UTCOffset

UTCOffset gets the Goment's UTC offset in minutes.

g.UTCOffset()
SetUTCOffset

SetUTCOffset sets the Goment's UTC offset in minutes. If the offset is less than 16 and greater than -16, the value is treated as hours.

g.SetUTCOffset(120)
Display
Format

Format takes a string of tokens and replaces them with their corresponding values to display the Goment.

Supported tokens
Token Output
Month M 1 2 ... 11 12
Mo 1st 2nd ... 11th 12th
MM 01 01 ... 11 12
MMM Jan Feb ... Nov Dec
MMMM January February ... November December
Day of Month D 1 2 ... 30 31
Do 1st 2nd ... 30th 31st
DD 01 02 ... 30 31
Day of Year DDD 1 2 ... 364 365
DDDo 1st 2nd ... 364th 365th
DDDD 001 002 ... 364 365
Day of Week d 0 1 ... 5 6
do 0th 1st ... 5th 6th
dd Su Mo ... Fr Sa
ddd Sun Mon ... Fri Sat
dddd Sunday Monday ... Friday Saturday
Day of Week (Locale) e 0 1 ... 5 6
Day of Week (ISO) E 1 2 ... 6 7
Week of Year w 1 2 ... 52 53
wo 1st 2nd ... 52nd 53rd
ww 01 02 ... 52 53
Week of Year (ISO) W 1 2 ... 52 53
Wo 1st 2nd ... 52nd 53rd
WW 01 02 ... 52 53
Year YY 70 71 ... 29 30
YYYY 1970 1971 ... 2029 2030
Y 1970 1971 ... 9999 +10000 +10001
Quarter Q 1 2 3 4
AM/PM A AM PM
a am pm
Hour H 0 1 ... 22 23
HH 00 01 ... 22 23
h 1 2 ... 11 12
hh 01 02 ... 11 12
k 1 2 ... 23 24
kk 01 02 ... 23 24
Minute m 0 1 ... 58 59
mm 00 01 ... 58 59
Second s 0 1 ... 58 59
ss 00 01 ... 58 59
Time Zone z or zz EST CST ... MST PST
Z -07:00 -06:00 ... +06:00 +07:00
ZZ -0700 -0600 ... +0600 +0700
Unix Timestamp X 1360013296
Time LT 8:30 PM
Time with seconds LTS 8:30:25 PM
Month numeral, day of month, year L 09/04/1986
l 9/4/1986
Month name, day of month, year LL September 4, 1986
ll Sep 4, 1986
Month name, day of month, year, time LLL September 4, 1986 8:30 PM
lll Sep 4, 1986 8:30 PM
Month name, day of month, day of week, year, time LLLL Thursday, September 4, 1986 8:30 PM
llll Thu, Sep 4, 1986 8:30 PM 
g.Format('YYYY-MM-DD')
FromNow

FromNow returns the relative time from now to the Goment time.

g.FromNow()
ToNow

ToNow returns the relative time to now to the Goment time.

g.ToNow()
From

From returns the relative time from the supplied time to the Goment time.

g.From(goment.New())
To

To returns the relative time from the Goment time to the supplied time.

g.To(goment.New())
Calendar

Calendar displays time relative to a given referenceTime (defaults to now).

g.Calendar()

Difference Diff returns the difference between two Goments as an integer.

g.Diff(goment.New(), 'years')
ToUnix

ToUnix returns the Unix timestamp (the number of seconds since the Unix Epoch).

g.ToUnix()
DaysInMonth

DaysInMonth returns the number of days in the set month.

g.DaysInMonth()
ToTime

ToTime returns the time.Time object that is wrapped by Goment.

g.ToTime()
ToArray

ToArray returns an array that mirrors the parameters from time.Date().

g.ToArray()
ToDateTime

ToDateTime returns a Goment.DateTime struct.

g.ToDateTime()
ToString

ToString returns a string representation of the Goment time.

g.ToString()
ToISOString

ToISOString returns a ISO8601 standard representation of the Goment time.

g.ToISOString()
Query
IsBefore

IsBefore will check if a Goment is before another Goment.

g.IsBefore(goment.New())
IsAfter

IsAfter will check if a Goment is after another Goment.

g.IsAfter(goment.New())
IsSame

IsSame will check if a Goment is the same as another Goment.

g.IsSame(goment.New())
IsSameOrBefore

IsSameOrBefore will check if a Goment is before or the same as another Goment.

g.IsSameOrBefore(goment.New())
IsSameOrAfter

IsSameOrAfter will check if a Goment is after or the same as another Goment.

g.IsSameOrAfter(goment.New())
IsBetween

IsBetween will check if a Goment is between two other Goments.

g.IsBetween(goment.New(), goment.New().Add(5, 'days))
IsDST

IsDST checks if the Goment is in daylight saving time.

g.IsDST()
IsLeapYear

IsLeapYear returns true if the Goment's year is a leap year, and false if it is not.

g.IsLeapYear()
IsTime

IsTime will check if a variable is a time.Time object.

g.IsTime(time.Now())
IsGoment

IsGoment will check if a variable is a Goment object.

g.IsGoment(goment.New())

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsGoment 

func IsGoment(obj interface{}) bool

IsGoment will check if a variable is a Goment object.

func IsTime 

func IsTime(obj interface{}) bool

IsTime will check if a variable is a time.Time object.

Types

type DateTime 

type DateTime struct {
	Year       int
	Month      int
	Day        int
	Hour       int
	Minute     int
	Second     int
	Nanosecond int
	Location   *time.Location
}

DateTime is a class to define a date & time.

type Diff 

type Diff struct {
	Start *Goment
	End   *Goment
}

Diff holds a start and end Goment.

func (Diff) InDays 

func (d Diff) InDays() int

InDays returns the duration in number of days.

func (Diff) InHours 

func (d Diff) InHours() int

InHours returns the duration in number of hours.

func (Diff) InMinutes 

func (d Diff) InMinutes() int

InMinutes returns the duration in number of minutes.

func (Diff) InMonths 

func (d Diff) InMonths() int

InMonths returns the duration in number of months.

func (Diff) InSeconds 

func (d Diff) InSeconds() int

InSeconds returns the duration in number of seconds.

func (Diff) InWeeks 

func (d Diff) InWeeks() int

InWeeks returns the duration in number of weeks.

func (Diff) InYears 

func (d Diff) InYears() int

InYears returns the duration in number of years.

type Goment 

type Goment struct {
	// contains filtered or unexported fields
}

Goment is the main class.

func New 

func New(args ...interface{}) (*Goment, error)

New creates an instance of the Goment library.

func Unix 

func Unix(unixSeconds int64) (*Goment, error)

Unix creates an instance of the Goment library from the Unix timestamp (seconds since the Unix Epoch).

func (*Goment) Add 

func (g *Goment) Add(args ...interface{}) *Goment

Add mutates the original Goment by adding time.

func (*Goment) Calendar 

func (g *Goment) Calendar(args ...interface{}) string

Calendar displays time relative to a given referenceTime (defaults to now).

func (*Goment) Clone 

func (g *Goment) Clone() *Goment

Clone creates a new copy of the Goment instance.

func (*Goment) Date 

func (g *Goment) Date() int

Date gets the day of the month.

func (*Goment) Day 

func (g *Goment) Day() int

Day gets the day of the week (Sunday = 0...).

func (*Goment) DayOfYear 

func (g *Goment) DayOfYear() int

DayOfYear gets the day of the year.

func (*Goment) DaysInMonth 

func (g *Goment) DaysInMonth() int

DaysInMonth returns the number of days in the set month.

func (*Goment) Diff 

func (g *Goment) Diff(args ...interface{}) int

Diff returns the difference between two Goments as an integer.

func (*Goment) EndOf 

func (g *Goment) EndOf(units string) *Goment

EndOf mutates the original Goment by setting it to the end of a unit of time.

func (*Goment) Format 

func (g *Goment) Format(args ...interface{}) string

Format takes a string of tokens and replaces them with their corresponding values to display the Goment.

func (*Goment) From 

func (g *Goment) From(args ...interface{}) string

From returns the relative time from the supplied time to the Goment time.

func (*Goment) FromNow 

func (g *Goment) FromNow(args ...interface{}) string

FromNow returns the relative time from now to the Goment time.

func (*Goment) Get 

func (g *Goment) Get(units string) int

Get is a string getter using the supplied units. Returns 0 if unsupported property.

func (*Goment) Hour 

func (g *Goment) Hour() int

Hour gets the hour.

func (*Goment) ISOWeek 

func (g *Goment) ISOWeek() int

ISOWeek gets the ISO week of the year.

func (*Goment) ISOWeekYear 

func (g *Goment) ISOWeekYear() int

ISOWeekYear gets the ISO week-year.

func (*Goment) ISOWeekday 

func (g *Goment) ISOWeekday() int

ISOWeekday gets the ISO day of the week with 1 being Monday and 7 being Sunday.

func (*Goment) ISOWeeksInYear 

func (g *Goment) ISOWeeksInYear() int

ISOWeeksInYear gets the number of weeks in the current Goment's year, according to ISO weeks.

func (*Goment) IsAfter 

func (g *Goment) IsAfter(args ...interface{}) bool

IsAfter will check if a Goment is after another Goment.

func (*Goment) IsBefore 

func (g *Goment) IsBefore(args ...interface{}) bool

IsBefore will check if a Goment is before another Goment.

func (*Goment) IsBetween 

func (g *Goment) IsBetween(args ...interface{}) bool

IsBetween will check if a Goment is between two other Goments.

func (*Goment) IsDST 

func (g *Goment) IsDST() bool

IsDST checks if the current Goment is in daylight saving time.

func (*Goment) IsLeapYear 

func (g *Goment) IsLeapYear() bool

IsLeapYear returns true if that year is a leap year, and false if it is not.

func (*Goment) IsSame 

func (g *Goment) IsSame(args ...interface{}) bool

IsSame will check if a Goment is the same as another Goment.

func (*Goment) IsSameOrAfter 

func (g *Goment) IsSameOrAfter(args ...interface{}) bool

IsSameOrAfter will check if a Goment is after or the same as another Goment.

func (*Goment) IsSameOrBefore 

func (g *Goment) IsSameOrBefore(args ...interface{}) bool

IsSameOrBefore will check if a Goment is before or the same as another Goment.

func (*Goment) Local 

func (g *Goment) Local() *Goment

Local will set the Goment to use local time.

func (*Goment) Millisecond 

func (g *Goment) Millisecond() int

Millisecond gets the milliseconds.

func (*Goment) Minute 

func (g *Goment) Minute() int

Minute gets the minutes.

func (*Goment) Month 

func (g *Goment) Month() int

Month gets the month (January = 1...).

func (*Goment) Nanosecond 

func (g *Goment) Nanosecond() int

Nanosecond gets the nanoseconds.

func (*Goment) Quarter 

func (g *Goment) Quarter() int

Quarter gets the quarter (1 to 4).

func (*Goment) Second 

func (g *Goment) Second() int

Second gets the seconds.

func (*Goment) Set 

func (g *Goment) Set(units string, value int) *Goment

Set is a generic setter, accepting units as the first argument, and value as the second.

func (*Goment) SetDate 

func (g *Goment) SetDate(date int) *Goment

SetDate sets the day of the month. If the date passed in is greater than the number of days in the month, then the day is set to the last day of the month.

func (*Goment) SetDay 

func (g *Goment) SetDay(day int) *Goment

SetDay sets the day of the week (Sunday = 0...).

func (*Goment) SetDayOfYear 

func (g *Goment) SetDayOfYear(doy int) *Goment

SetDayOfYear sets the day of the year. For non-leap years, 366 is treated as 365.

func (*Goment) SetHour 

func (g *Goment) SetHour(hours int) *Goment

SetHour sets the hour.

func (*Goment) SetISOWeek 

func (g *Goment) SetISOWeek(week int) *Goment

SetISOWeek sets the ISO week of the year.

func (*Goment) SetISOWeekYear 

func (g *Goment) SetISOWeekYear(weekYear int) *Goment

SetISOWeekYear sets the ISO week-year.

func (*Goment) SetISOWeekday 

func (g *Goment) SetISOWeekday(weekday int) *Goment

SetISOWeekday sets the ISO day of the week with 1 being Monday and 7 being Sunday.

func (*Goment) SetMillisecond 

func (g *Goment) SetMillisecond(milliseconds int) *Goment

SetMillisecond sets the milliseconds.

func (*Goment) SetMinute 

func (g *Goment) SetMinute(minutes int) *Goment

SetMinute sets the minutes.

func (*Goment) SetMonth 

func (g *Goment) SetMonth(month int) *Goment

SetMonth sets the month (January = 1...). If new month has less days than current month, the date is pinned to the end of the target month.

func (*Goment) SetNanosecond 

func (g *Goment) SetNanosecond(nanoseconds int) *Goment

SetNanosecond sets the nanoseconds.

func (*Goment) SetQuarter 

func (g *Goment) SetQuarter(quarter int) *Goment

SetQuarter sets the quarter (1 to 4).

func (*Goment) SetSecond 

func (g *Goment) SetSecond(seconds int) *Goment

SetSecond sets the seconds.

func (*Goment) SetUTCOffset 

func (g *Goment) SetUTCOffset(offset int) *Goment

SetUTCOffset sets the UTC offset in minutes. If the offset is less than 16 and greater than -16, the value is treated as hours.

func (*Goment) SetWeek 

func (g *Goment) SetWeek(week int) *Goment

SetWeek sets the week of the year according to the locale.

func (*Goment) SetWeekYear 

func (g *Goment) SetWeekYear(weekYear int) *Goment

SetWeekYear sets the week-year according to the locale.

func (*Goment) SetWeekday 

func (g *Goment) SetWeekday(weekday int) *Goment

SetWeekday sets the day of the week according to the locale.

func (*Goment) SetYear 

func (g *Goment) SetYear(year int) *Goment

SetYear sets the year.

func (*Goment) StartOf 

func (g *Goment) StartOf(units string) *Goment

StartOf mutates the original Goment by setting it to the start of a unit of time.

func (*Goment) Subtract 

func (g *Goment) Subtract(args ...interface{}) *Goment

Subtract mutates the original Goment by subtracting time.

func (*Goment) To 

func (g *Goment) To(args ...interface{}) string

To returns the relative time from the Goment time to the supplied time.

func (*Goment) ToArray 

func (g *Goment) ToArray() []int

ToArray returns an array that mirrors the parameters from time.Date().

func (*Goment) ToDateTime 

func (g *Goment) ToDateTime() DateTime

ToDateTime returns a DateTime struct.

func (*Goment) ToISOString 

func (g *Goment) ToISOString() string

ToISOString returns a ISO8601 standard representation of the Goment time.

func (*Goment) ToNow 

func (g *Goment) ToNow(args ...interface{}) string

ToNow returns the relative time to now to the Goment time.

func (*Goment) ToString 

func (g *Goment) ToString() string

ToString returns a string representation of the Goment time.

func (*Goment) ToTime 

func (g *Goment) ToTime() time.Time

ToTime returns the time.Time object that is wrapped by Goment.

func (*Goment) ToUnix 

func (g *Goment) ToUnix() int64

ToUnix returns the Unix timestamp (the number of seconds since the Unix Epoch).

func (*Goment) UTC 

func (g *Goment) UTC() *Goment

UTC will set the Goment to use UTC time.

func (*Goment) UTCOffset 

func (g *Goment) UTCOffset() int

UTCOffset get the UTC offset in minutes.

func (*Goment) Week 

func (g *Goment) Week() int

Week gets the week of the year according to the locale.

func (*Goment) WeekYear 

func (g *Goment) WeekYear() int

WeekYear gets the week-year according to the locale.

func (*Goment) Weekday 

func (g *Goment) Weekday() int

Weekday gets the day of the week according to the locale.

func (*Goment) WeeksInYear 

func (g *Goment) WeeksInYear() int

WeeksInYear gets the number of weeks according to locale in the current Goment's year.

func (*Goment) Year 

func (g *Goment) Year() int

Year gets the year.

Source Files

View all Source files

Directories

Path Synopsis
internal
constants Module
regexps Module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.