firstWhere method

  1. @override
E firstWhere(
  1. Test<E> test, {
  2. OrElse<E>? orElse,
})
override

The first element that satisfies the given predicate test.

Iterates through elements and returns the first to satisfy test.

Example:

final numbers = <int>[1, 2, 3, 5, 6, 7];
var result = numbers.firstWhere((element) => element < 5); // 1
result = numbers.firstWhere((element) => element > 5); // 6
result =
    numbers.firstWhere((element) => element > 10, orElse: () => -1); // -1

If no element satisfies test, the result of invoking the orElse function is returned. If orElse is omitted, it defaults to throwing a StateError. Stops iterating on the first matching element.

Implementation

@override
E firstWhere(Test<E> test, {OrElse<E>? orElse}) =>
    elements.firstWhere(test, orElse: orElse);