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

2.1 KiB

title description menu weight
date.week() function `date.week()` returns the ISO week of the year for a specified time. Results range from `[1 - 53]`.
flux_v0_ref
name parent identifier
date.week date date/week
101

date.week() returns the ISO week of the year for a specified time. Results range from [1 - 53].

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 week of the year

import "date"

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


Return the week of the year using a relative duration

import "date"

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

date.week(t: -12d)// Returns 42


Return the current week of the year

import "date"

date.week(t: now())