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

2.2 KiB

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

date.hour() returns the hour of a specified time. Results range from [0 - 23].

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 hour of a time value

import "date"

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


Return the hour of a relative duration

import "date"

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

date.hour(t: -8h)// Returns 7


Return the current hour

import "date"

date.hour(t: now())

Return the hour in local time

import "date"
import "timezone"

date.hour(t: r._time, location: timezone.location(name: "Europe/Berlin"))