getTimeDifferenceMs method

  1. @useResult
int? getTimeDifferenceMs(
  1. DateTime? compareTo, {
  2. bool isAlwaysPositive = true,
})

Returns the time difference in milliseconds between this DateTime and compareTo, or null if compareTo is null.

When isAlwaysPositive is true (default), the result is always non-negative. Audited: 2026-06-12 11:26 EDT

Implementation

@useResult
int? getTimeDifferenceMs(DateTime? compareTo, {bool isAlwaysPositive = true}) {
  if (compareTo == null) {
    return null;
  }

  final int inMilliseconds = difference(compareTo).inMilliseconds;

  return isAlwaysPositive ? inMilliseconds.abs() : inMilliseconds;
}