docs-v2/content/flux/v0/stdlib/date/year.md

2.0 KiB

title description menu weight
date.year() function `date.year()` returns the year of a specified time.
flux_v0_ref
name parent identifier
date.year date date/year
101

date.year() returns the year of a specified time.

Function type signature
(t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

t

({{< req >}}) Time to operate on.

Use an absolute time, relative duration, or integer. Durations are relative to now().

location

Location used to determine timezone. Default is the location option.

Examples

Return the year for a time value

import "date"

date.year(t: 2020-02-11T12:21:03.29353494Z)// Returns 2020


Return the year for a relative duration

import "date"

option now = () => 2020-02-11T12:21:03.29353494Z

date.year(t: -14y)// Returns 2007


Return the current year

import "date"

date.year(t: now())