date.weekDay() function

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

Function type signature

(t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable

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
• Return the day of the week for a relative duration
• Return the current day of the week

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())