Documentation

date.weekDay() function

date.weekDay() returns the day of the week for a specified time. Results range from [0 - 6].

Returned valueDay of the week
0Sunday
1Monday
2Tuesday
3Wednesday
4Thursday
5Friday
6Saturday
Function type signature
(t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable

For more information, see Function type signatures.

Parameters

t

(Required) 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 week for a time value

import "date"

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

Return the day of the week for a relative duration

import "date"

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

date.weekDay(t: -84h)// Returns 6

Return the current day of the week

import "date"

date.weekDay(t: now())

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more