fake_async 1.1.0

  • Readme
  • Changelog
  • Installing
  • 93

This package provides a FakeAsync class, which makes it easy to deterministically test code that uses asynchronous features like Futures, Streams, Timers, and microtasks. It creates an environment in which the user can explicitly control Dart's notion of the "current time". When the time is advanced, FakeAsync fires all asynchronous events that are scheduled for that time period without actually needing the test to wait for real time to elapse.

For example:

import 'dart:async';

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

void main() {
  test("Future.timeout() throws an error once the timeout is up", () {
    // Any code run within [fakeAsync] is run within the context of the
    // [FakeAsync] object passed to the callback.
    fakeAsync((async) {
      // All asynchronous features that rely on timing are automatically
      // controlled by [fakeAsync].
      expect(new Completer().future.timeout(new Duration(seconds: 5)),
          throwsA(new isInstanceOf<TimeoutException>()));

      // This will cause the timeout above to fire immediately, without waiting
      // 5 seconds of real time.
      async.elapse(new Duration(seconds: 5));

Integration With clock #

FakeAsync can't control the time reported by new DateTime.now() or by the Stopwatch class, since they're not part of dart:async. However, if you create them using the clock package's clock.now() or clock.getStopwatch() functions, FakeAsync will automatically override them to use the same notion of time as dart:async classes.

1.1.0 #

  • Exposed the FakeTimer class as a public class.
  • Added FakeAsync.pendingTimers which gives access to all pending timers at the time of the call.

1.0.2 #

  • Update min SDK to 2.2.0

1.0.1 #

  • Update to lowercase Dart core library constants.
  • Fix use of deprecated isInstanceOf matcher.

1.0.0 #

This release contains the FakeAsync class that was defined in quiver. It's backwards-compatible with both the quiver version and the old version of the fake_async package.

New Features #

  • A top-level fakeAsync() function was added that encapsulates new FakeAsync().run(...).

New Features Relative to quiver #

  • FakeAsync.elapsed returns the total amount of fake time elapsed since the FakeAsync instance was created.

  • new FakeAsync() now takes an initialTime argument that sets the default time for clocks created with FakeAsync.getClock(), and for the clock package's top-level clock variable.

New Features Relative to fake_async 0.1 #

  • FakeAsync.periodicTimerCount, FakeAsync.nonPeriodicTimerCount, and FakeAsync.microtaskCount provide visibility into the events scheduled within FakeAsync.run().

  • FakeAsync.getClock() provides access to fully-featured Clock objects based on FakeAsync's elapsed time.

  • FakeAsync.flushMicrotasks() empties the microtask queue without elapsing any time or running any timers.

  • FakeAsync.flushTimers() runs all microtasks and timers until there are no more scheduled.

0.1.2 #

  • Integrate with the clock package.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  fake_async: ^1.1.0

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:fake_async/fake_async.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on May 26, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.1
  • pana: 0.13.8-dev

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and fake_async.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.0 <3.0.0
clock ^1.0.0 1.0.1
collection ^1.8.0 1.14.12
Transitive dependencies
meta 1.1.8
Dev dependencies
async ^2.0.0
test ^1.0.0