1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
ns: time
preamble: |
This namespace wraps Go's [`time` package](https://pkg.go.dev/time/), and a
few of the functions return a `time.Time` value. All of the
[`time.Time` functions](https://pkg.go.dev/time/#Time) can then be used to
convert, adjust, or format the time in your template.
### Reference time
An important difference between this and many other time/date utilities is how
parsing and formatting is accomplished. Instead of relying solely on pre-defined
formats, or having a complex system of variables, formatting is accomplished by
declaring an example of the layout you wish to display.
This uses a _reference time_, which is:
```
Mon Jan 2 15:04:05 -0700 MST 2006
```
### Constants
#### format layouts
Some pre-defined layouts have been provided for convenience:
| layout name | value |
|-------------|-------|
| `time.ANSIC` | `"Mon Jan _2 15:04:05 2006"` |
| `time.UnixDate` | `"Mon Jan _2 15:04:05 MST 2006"` |
| `time.RubyDate` | `"Mon Jan 02 15:04:05 -0700 2006"` |
| `time.RFC822` | `"02 Jan 06 15:04 MST"` |
| `time.RFC822Z` | `"02 Jan 06 15:04 -0700"` // RFC822 with numeric zone |
| `time.RFC850` | `"Monday, 02-Jan-06 15:04:05 MST"` |
| `time.RFC1123` | `"Mon, 02 Jan 2006 15:04:05 MST"` |
| `time.RFC1123Z` | `"Mon, 02 Jan 2006 15:04:05 -0700"` // RFC1123 with numeric zone |
| `time.RFC3339` | `"2006-01-02T15:04:05Z07:00"` |
| `time.RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` |
| `time.Kitchen` | `"3:04PM"` |
| `time.Stamp` | `"Jan _2 15:04:05"` |
| `time.StampMilli` | `"Jan _2 15:04:05.000" `|
| `time.StampMicro` | `"Jan _2 15:04:05.000000"` |
| `time.StampNano` | `"Jan _2 15:04:05.000000000"` |
See below for examples of how these layouts can be used.
#### durations
Some operations (such as [`Time.Add`](https://pkg.go.dev/time/#Time.Add) and
[`Time.Round`](https://pkg.go.dev/time/#Time.Round)) require a
[`Duration`](https://pkg.go.dev/time/#Duration) value. These can be created
conveniently with the following functions:
- `time.Nanosecond`
- `time.Microsecond`
- `time.Millisecond`
- `time.Second`
- `time.Minute`
- `time.Hour`
For example:
```console
$ gomplate -i '{{ (time.Now).Format time.Kitchen }}
{{ ((time.Now).Add (time.Hour 2)).Format time.Kitchen }}'
9:05AM
11:05AM
```
For other durations, such as `2h10m`, [`time.ParseDuration`](#timeparseduration) can be used.
funcs:
- name: time.Now
released: v2.1.0
description: |
Returns the current local time, as a `time.Time`. This wraps [`time.Now`](https://pkg.go.dev/time/#Now).
Usually, further functions are called using the value returned by `Now`.
pipeline: false
rawExamples:
- |
Usage with [`UTC`](https://pkg.go.dev/time/#Time.UTC) and [`Format`](https://pkg.go.dev/time/#Time.Format):
```console
$ gomplate -i '{{ (time.Now).UTC.Format "Day 2 of month 1 in year 2006 (timezone MST)" }}'
Day 14 of month 10 in year 2017 (timezone UTC)
```
- |
Usage with [`AddDate`](https://pkg.go.dev/time/#Time.AddDate):
```console
$ date
Sat Oct 14 09:57:02 EDT 2017
$ gomplate -i '{{ ((time.Now).AddDate 0 1 0).Format "Mon Jan 2 15:04:05 MST 2006" }}'
Tue Nov 14 09:57:02 EST 2017
```
_(notice how the TZ adjusted for daylight savings!)_
- |
Usage with [`IsDST`](https://pkg.go.dev/time/#Time.IsDST):
```console
$ gomplate -i '{{ $t := time.Now }}At the tone, the time will be {{ ($t.Round (time.Minute 1)).Add (time.Minute 1) }}.
It is{{ if not $t.IsDST }} not{{ end }} daylight savings time.
... ... BEEP'
At the tone, the time will be 2022-02-10 09:01:00 -0500 EST.
It is not daylight savings time.
... ... BEEP
```
- name: time.Parse
released: v2.1.0
description: |
Parses a timestamp defined by the given layout. This wraps [`time.Parse`](https://pkg.go.dev/time/#Parse).
A number of pre-defined layouts are provided as constants, defined
[here](https://pkg.go.dev/time/#pkg-constants).
Just like [`time.Now`](#timenow), this is usually used in conjunction with
other functions.
_Note: In the absence of a time zone indicator, `time.Parse` returns a time in UTC._
pipeline: true
arguments:
- name: layout
required: true
description: The layout string to parse with
- name: timestamp
required: true
description: The timestamp to parse
rawExamples:
- |
Usage with [`Format`](https://pkg.go.dev/time/#Time.Format):
```console
$ gomplate -i '{{ (time.Parse "2006-01-02" "1993-10-23").Format "Monday January 2, 2006 MST" }}'
Saturday October 23, 1993 UTC
```
- name: time.ParseDuration
released: v2.1.0
description: |
Parses a duration string. This wraps [`time.ParseDuration`](https://pkg.go.dev/time/#ParseDuration).
A duration string is a possibly signed sequence of decimal numbers, each with
optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. Valid
time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
pipeline: true
arguments:
- name: duration
required: true
description: The duration string to parse
examples:
- |
$ gomplate -i '{{ (time.Now).Format time.Kitchen }}
{{ ((time.Now).Add (time.ParseDuration "2h30m")).Format time.Kitchen }}'
12:43AM
3:13AM
- name: time.ParseLocal
released: v2.2.0
description: |
Same as [`time.Parse`](#timeparse), except that in the absence of a time zone
indicator, the timestamp will be parsed in the local timezone.
pipeline: true
arguments:
- name: layout
required: true
description: The layout string to parse with
- name: timestamp
required: true
description: The timestamp to parse
rawExamples:
- |
Usage with [`Format`](https://pkg.go.dev/time/#Time.Format):
```console
$ bin/gomplate -i '{{ (time.ParseLocal time.Kitchen "6:00AM").Format "15:04 MST" }}'
06:00 EST
```
- name: time.ParseInLocation
released: v2.2.0
description: |
Same as [`time.Parse`](#timeparse), except that the time is parsed in the given location's time zone.
This wraps [`time.ParseInLocation`](https://pkg.go.dev/time/#ParseInLocation).
pipeline: true
arguments:
- name: layout
required: true
description: The layout string to parse with
- name: location
required: true
description: The location to parse in
- name: timestamp
required: true
description: The timestamp to parse
rawExamples:
- |
Usage with [`Format`](https://pkg.go.dev/time/#Time.Format):
```console
$ gomplate -i '{{ (time.ParseInLocation time.Kitchen "Africa/Luanda" "6:00AM").Format "15:04 MST" }}'
06:00 LMT
```
- name: time.Since
released: v2.5.0
description: |
Returns the time elapsed since a given time. This wraps [`time.Since`](https://pkg.go.dev/time/#Since).
It is shorthand for `time.Now.Sub t`.
pipeline: true
arguments:
- name: t
required: true
description: the `Time` to calculate since
examples:
- |
$ gomplate -i '{{ $t := time.Parse time.RFC3339 "1970-01-01T00:00:00Z" }}time since the epoch:{{ time.Since $t }}'
time since the epoch:423365h0m24.353828924s
- name: time.Unix
released: v2.1.0
description: |
Returns the local `Time` corresponding to the given Unix time, in seconds since
January 1, 1970 UTC. Note that fractional seconds can be used to denote
milliseconds, but must be specified as a string, not a floating point number.
pipeline: true
arguments:
- name: time
required: true
description: the time to parse
rawExamples:
- |
_with whole seconds:_
```console
$ gomplate -i '{{ (time.Unix 42).UTC.Format time.Stamp}}'
Jan 1, 00:00:42
```
_with fractional seconds:_
```console
$ gomplate -i '{{ (time.Unix "123456.789").UTC.Format time.StampMilli}}'
Jan 2 10:17:36.789
```
- name: time.Until
released: v2.5.0
description: |
Returns the duration until a given time. This wraps [`time.Until`](https://pkg.go.dev/time/#Until).
It is shorthand for `$t.Sub time.Now`.
pipeline: true
arguments:
- name: t
required: true
description: the `Time` to calculate until
rawExamples:
- |
```console
$ gomplate -i '{{ $t := time.Parse time.RFC3339 "2020-01-01T00:00:00Z" }}only {{ time.Until $t }} to go...'
only 14922h56m46.578625891s to go...
```
Or, less precise:
```console
$ bin/gomplate -i '{{ $t := time.Parse time.RFC3339 "2020-01-01T00:00:00Z" }}only {{ (time.Until $t).Round (time.Hour 1) }} to go...'
only 14923h0m0s to go...
```
- name: time.ZoneName
released: v2.1.0
description: |
Return the local system's time zone's name.
pipeline: false
examples:
- |
$ gomplate -i '{{time.ZoneName}}'
EDT
- name: time.ZoneOffset
released: v2.2.0
description: |
Return the local system's time zone offset, in seconds east of UTC.
pipeline: false
examples:
- |
$ gomplate -i '{{time.ZoneOffset}}'
-14400
|
