Year constructor

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

Creates $year operator expression

Returns the year portion of a date.

  • 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

Year(date, {timezone})
    : super('year', AEObject({'date': date, 'timezone': timezone}));