TimeRange.unit

Author: sadespresso

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.1.0
+
+- `TimeRange` now has a `unit` property that returns its corresponding
+  DurationUnit type if available.
+
 ## 3.0.0
 
 > This release has breaking changes!

lib/src/time_range.dart

@@ -16,6 +16,8 @@ abstract class TimeRange {
   DateTime get from;
   DateTime get to;
 
+  DurationUnit? get unit;
+
   /// Returns true if [dateTime] is between [from] and [to] (inclusive)
   bool contains(DateTime dateTime) => from <= dateTime && dateTime <= to;
 

lib/src/time_range/custom.dart

@@ -14,6 +14,9 @@ class CustomTimeRange extends TimeRange {
   @override
   final DateTime to;
 
+  @override
+  DurationUnit? get unit => null;
+
   /// The timezone is assumed by the [from] passed in here.
   ///
   /// [CustomTimeRange] does NOT ensure that [from] and [to] have the same timezone.

lib/src/time_range/day.dart

@@ -33,6 +33,9 @@ class DayTimeRange extends TimeRange with PageableRange<DayTimeRange> {
   @override
   DateTime get to => from.startOfNextDay();
 
+  @override
+  DurationUnit get unit => DurationUnit.day;
+
   @override
   DayTimeRange toUtc() =>
       isUtc ? this : DayTimeRange(year, month, day, isUtc: true);

lib/src/time_range/hour.dart

@@ -36,6 +36,9 @@ class HourTimeRange extends TimeRange with PageableRange<HourTimeRange> {
   @override
   DateTime get to => from.startOfNextHour();
 
+  @override
+  DurationUnit get unit => DurationUnit.hour;
+
   @override
   HourTimeRange toUtc() =>
       isUtc ? this : HourTimeRange(year, month, day, hour, isUtc: true);

lib/src/time_range/month.dart

@@ -29,6 +29,9 @@ class MonthTimeRange extends TimeRange with PageableRange<MonthTimeRange> {
   @override
   DateTime get to => from.startOfNextMonth();
 
+  @override
+  DurationUnit get unit => DurationUnit.month;
+
   @override
   MonthTimeRange toUtc() =>
       isUtc ? this : MonthTimeRange(year, month, isUtc: true);

lib/src/time_range/week.dart

@@ -13,6 +13,9 @@ class LocalWeekTimeRange extends CustomTimeRange
           dateTime.endOfLocalWeek(weekStart),
         );
 
+  @override
+  DurationUnit get unit => DurationUnit.week;
+
   @override
   CustomTimeRange toUtc() => throw UnsupportedError(
       "Local week time range cannot be converted to UTC");
@@ -34,6 +37,9 @@ class IsoWeekTimeRange extends CustomTimeRange
   int get weekYear => from.weekYear;
   int get week => from.week;
 
+  @override
+  DurationUnit get unit => DurationUnit.week;
+
   @override
   CustomTimeRange toUtc() =>
       throw UnsupportedError("ISO week time range cannot be converted to UTC");

lib/src/time_range/year.dart

@@ -25,6 +25,9 @@ class YearTimeRange extends TimeRange with PageableRange<YearTimeRange> {
   @override
   DateTime get to => from.startOfNextYear();
 
+  @override
+  DurationUnit get unit => DurationUnit.year;
+
   @override
   YearTimeRange toUtc() => isUtc ? this : YearTimeRange(year, isUtc: true);
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: moment_dart
 description: Multi-purpose immutable DateTime subclass. Supports multiple localizations to easily convert DateTime and Duration into human-readable format
-version: 3.0.0
+version: 3.1.0
 homepage: https://github.com/sadespresso/moment_dart
 issue_tracker: https://github.com/sadespresso/moment_dart/issues
 funding: