ce4ff5144995a54e321b175746840f291df7e4f3 - clock

commit	ce4ff5144995a54e321b175746840f291df7e4f3	[log] [tgz]
author	Devon Carew <devoncarew@google.com>	Wed Jun 15 13:53:42 2022 -0700
committer	GitHub <noreply@github.com>	Wed Jun 15 13:53:42 2022 -0700
tree	12b4f1667184c57e99f660c976338a3829e5e4ef
parent	49cd69511d14d041a2504f60d5775b8febcd8274 [diff]

tree: 12b4f1667184c57e99f660c976338a3829e5e4ef

README.md

This package provides a Clock class which encapsulates the notion of the “current time” and provides easy access to points relative to the current time. Different Clocks can have a different notion of the current time, and the default top-level clock's notion can be swapped out to reliably test timing-dependent code.

For example, you can use clock in your libraries like this:

// run_with_timing.dart
import 'package:clock/clock.dart';

/// Runs [callback] and prints how long it took.
T runWithTiming<T>(T Function() callback) {
  var stopwatch = clock.stopwatch()..start();
  var result = callback();
  print('It took ${stopwatch.elapsed}!');
  return result;
}

...and then test your code using the fake_async package, which automatically overrides the current clock:

// run_with_timing_test.dart
import 'run_with_timing.dart';

import 'package:fake_async/fake_async.dart';
import 'package:test/test.dart';

void main() {
  test('runWithTiming() prints the elapsed time', () {
    FakeAsync().run((async) {
      expect(() {
        runWithTiming(() {
          async.elapse(Duration(seconds: 10));
        });
      }, prints('It took 0:00:10.000000!'));
    });
  });
}