prefer-unwrapping-future-or

added in: 1.4.0

warning

Warns when a FutureOr is not unwrapped before being used.

Awaiting FutureOr without checking if the returned value is actually a Future results in unnecessary async gap.

Additional info:

• https://stackoverflow.com/questions/59213196/what-is-the-purpose-of-futureor/59251907#59251907

Example

❌ Bad:

FutureOr<int> futureOrFunction() async => 1;

Future<void> main() async {
  await futureOrFunction(); // LINT
}

✅ Good:

FutureOr<int> futureOrFunction() async => 1;

Future<void> main() async {
  final futureOr = futureOrFunction();

  int result;
  if (futureOr is Future) {
    result = await futureOr;
  } else {
    result = futureOr;
  }

  // Or

  final value = futureOr is Future ? await futureOr : futureOr;
}