Skip to main content

unnecessary_await_in_return

Learn about the unnecessary_await_in_return linter rule.

Deprecated
Fix available
Released in Dart 2.1

Unnecessary await keyword in return.

Details

#

NOTE: As following this lint rule everywhere (specially when not reported) can lead to unexpected errors, this lint has been deprecated. Remove all inclusions of this lint from your analysis options.

Avoid returning an awaited expression when the expression type is assignable to the function's return type.

BAD:

dart
Future<int> future;
Future<int> f1() async => await future;
Future<int> f2() async {
  return await future;
}

GOOD:

dart
Future<int> future;
Future<int> f1() => future;
Future<int> f2() {
  return future;
}

Enable

#

To enable the unnecessary_await_in_return rule, add unnecessary_await_in_return under linter > rules in your analysis_options.yaml file:

analysis_options.yaml
yaml
linter:
  rules:
    - unnecessary_await_in_return

If you're instead using the YAML map syntax to configure linter rules, add unnecessary_await_in_return: true under linter > rules:

analysis_options.yaml
yaml
linter:
  rules:
    unnecessary_await_in_return: true