Choose where you’d like to start

getDayOfWeek

Table of Contents

Overview

The getDayOfWeek function takes a dateTimeValue as an argument, and returns a number representing the day of the week on which the specified dateTimeValue falls.

1 represents Sunday, 2 represents Monday, and so on, with 7 being the final number representing Saturday.

Return Type

  • Number

Syntax

<variable> = <dateTimeValue>.getDayOfWeek();

(OR)

<variable> = getDayOfWeek( <dateTimeValue>);

(OR)

<variable> = <dateTimeValue>.weekday();

(OR)

<variable> = weekday( <dateTimeValue>);
ParameterDescriptionData type
<variable>Variable which will contain the returned number.NUMBER
<dateTimeValue>

The date-time value based on which a number will be returned.

The time value is not taken into account while using this function.

A runtime error will be encountered if:

  • the specified 2 digit date value exceeds the number of days in that month.
  • an incorrect month value is specified in 3 or more characters.

The function returns a null value if:

  • the month value is specified in less than 3 characters.
  • the hour value, or the minutes value, or the seconds value is specified in more than 2 digits.
  • the date value is specified in more than 2 digits.
  • the year value has more than 4 digits.

Refer this help document to learn about the supported date-time formats.

DATE-TIME

Examples

currentDate = '15-Mar-2019';
dayNumber = currentDate.getDayOfWeek();          // returns 6 (meaning Friday)

Get Started Now

Execute