DayOfWeek constructor

DayOfWeek(
  1. dynamic date, {
  2. dynamic timezone,
})

Creates $dayOfWeek operator expression

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

  • date - The date to which the operator is applied. date must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
  • {timezone} - Optional. The timezone of the operation result. {timezone} must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.

Implementation

DayOfWeek(date, {timezone})
    : super('dayOfWeek', AEObject({'date': date, 'timezone': timezone}));