IterableFindExtension<E> extension

Convenience methods for searching, grouping, sorting, and aggregating iterables.

on

• Iterable<E>

Properties

firstOrNull → E?

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns the first element, or null if this iterable is empty.

no setter

lastOrNull → E?

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns the last element, or null if this iterable is empty.

no setter

Methods

associateBy<K>(K keySelector(E element)) → Map<K, E>

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns a map keyed by keySelector.

average({num value(dynamic)?}) → num?

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns the average of all the values in this iterable, as defined by value.

chunks(int chunkSize) → Iterable<List<E>>

Available on Iterable<E>, provided by the IterableFindExtension extension

Split one large list to limited sub lists

count([bool test(E element)?]) → int

Available on Iterable<E>, provided by the IterableFindExtension extension

Counts elements that satisfy test.

elementAtOrNull(int index) → E?

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns the element at index, or null if index is out of range.

find(bool test(E element), {E orElse()?}) → E?

Available on Iterable<E>, provided by the IterableFindExtension extension

find the first element that satisfies the given predicate test.

findIndex(bool test(E element)) → int

Available on Iterable<E>, provided by the IterableFindExtension extension

find the first element index that satisfies the given predicate test.

flat<E>({int? depth, dynamic toElements(dynamic e)?}) → Iterable<E>

Available on Iterable<E>, provided by the IterableFindExtension extension

Flats each element of this Iterable into zero or more elements.

groupBy<K>(K keySelector(E element)) → Map<K, List<E>>

Available on Iterable<E>, provided by the IterableFindExtension extension

Groups elements by a key produced from each element.

max({num value(dynamic)?}) → E

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns the element with the maximum value in the iterable.

min({num value(dynamic)?}) → E

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns the element with the minimum value in the iterable.

sortedBy<T extends Comparable>(T selector(E element), {bool descending = false}) → List<E>

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns a sorted list using the comparable value from selector.

sum([num addend(dynamic)?]) → num

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns the sum of all the values in this iterable, as defined by addend.

unique([bool comparator(E a, E b)?]) → Iterable<E>

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns a new lazy Iterable with unique elements from this collection.

uniqueBy<K>(K keySelector(E element)) → Iterable<E>

Available on Iterable<E>, provided by the IterableFindExtension extension

Returns a new Iterable containing only the elements that have unique keys.