docs-v2/content/flux/v0.x/stdlib/date/weekday.md

57 lines
1.1 KiB
Markdown

---
title: date.weekDay() function
description: >
The `date.weekDay()` function returns the day of the week for a specified time.
Results range from `[0-6]`.
aliases:
- /influxdb/v2.0/reference/flux/functions/date/weekday/
- /influxdb/v2.0/reference/flux/stdlib/date/weekday/
- /influxdb/cloud/reference/flux/stdlib/date/weekday/
menu:
flux_0_x_ref:
name: date.weekDay
parent: date
weight: 301
introduced: 0.37.0
---
The `date.weekDay()` function returns the day of the week for a specified time.
Results range from `[0-6]`.
```js
import "date"
date.weekDay(t: 2019-07-17T12:05:21.012Z)
// Returns 3
```
## Parameters
### t {data-type="time, duration"}
The time to operate on.
Use an absolute time, relative duration, or integer.
Durations are relative to `now()`.
## Examples
##### Return the day of the week for a time value
```js
import "date"
date.weekDay(t: 2020-02-11T12:21:03.293534940Z)
// Returns 2
```
##### Return the day of the week for a relative duration
```js
import "date"
option now = () => 2020-02-11T12:21:03.293534940Z
date.weekDay(t: -84h)
// Returns 6
```