formatTimeDifference function

String formatTimeDifference(DateTime time, { DateTime? now, })

Formats a DateTime into the 'X ago' string format.

Implementation

String formatTimeDifference(DateTime time, {DateTime? now}) {
  now ??= DateTime.now();
  final timeOfDay = timeFormat.format(time);
  final deltaDays = now.difference(time).inDays.abs();

  if (deltaDays < 1 && now.day == time.day) {
    // "Today, XX:XXam"
    return TimeIntl.today(timeOfDay);
  }

  if (deltaDays < 2 && now.weekday == (time.weekday + 1) % 7) {
    // "Yesterday, XX:XXam"
    return TimeIntl.yesterday(timeOfDay);
  }

  // Weekday check prevents ambiguity between dates that are
  // almost a week apart in the same week day.
  if (deltaDays < 7 && now.weekday != time.weekday) {
    // "Tuesday, XX:XXam"
    return TimeIntl.dateAndTime(weekdayFormat.format(time), timeOfDay);
  }

  // Month check prevents ambiguity between dates that are
  // almost a year apart in the same month.
  if (deltaDays < 365 && (now.year == time.year || now.month != time.month)) {
    // "January 25, XX:XXam"
    return TimeIntl.dateAndTime(monthDayFormat.format(time), timeOfDay);
  }

  // "Jan 5, 2016"
  return '${yearMonthDayFormat.format(time)}';
}