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

2.2 KiB

title description menu weight
date.yearDay() function `date.yearDay()` returns the day of the year for a specified time. Results can include leap days and range from `[1 - 366]`.
flux_v0_ref
name parent identifier
date.yearDay date date/yearDay
101

date.yearDay() returns the day of the year for a specified time. Results can include leap days and range from [1 - 366].

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 day of the year for a time value

import "date"

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


Return the day of the year for a relative duration

import "date"

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

date.yearDay(t: -1mo)// Returns 276


Return the current day of the year

import "date"

date.yearDay(t: now())