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

2.5 KiB

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

date.month() returns the month of a specified time. Results range from [1 - 12].

Returned value Month
1 January
2 February
3 March
4 April
5 May
6 June
7 July
8 August
9 September
10 October
11 November
12 December
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 month of a time value

import "date"

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


Return the month of a relative duration

import "date"

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

date.month(t: -3mo)// Returns 8


Return the current numeric month

import "date"

date.month(t: now())