yearStart property

  1. @useResult
DateTime get yearStart

Gets the start date of the year.

Returns: DateTime: The first day of the year.

Throws: ArgumentError: If the year is greater than 9999.

Implementation

@useResult
DateTime get yearStart {
  if (year > DateConstants.maxYear) {
    throw ArgumentError(_yearExceedsMaxMessage);
  }

  return DateTime(year);
}