Skip to content

Latest commit

 

History

History
executable file
·
194 lines (151 loc) · 6.3 KB

README.md

File metadata and controls

executable file
·
194 lines (151 loc) · 6.3 KB
Raw

Logo

Travis Coveralls Version Runtime GitHub license

If you come from Kotlin, you will appreciate all the handy extensions for lists.
With superpower, you can use them in your Flutter app.

Resources:

Get started 🎉

Just wrap your existing List with $(myList) or create a new empty list with $() and you are good to go.

var superList = $([0, 10, 100, 1000]);
var sum = superList.sum(); // 1110
var last = superList[-1]; // 1000
var lastTwo = superList.slice(-2); // [100, 1000]

Iterables can be wrapped with $it(myIterable) and Maps with $map(myMap).

Introduction to superpowers ❤️

Negative indices

This is one of the coolest features: You can use negative indices which start at the last element of the list: list[-1] is the same as list[list.length - 1].

Here is a sample with negative indices:

// Negative indices: -4   -3   -2   -1
var superlist =  $([ '0', '1', '2', '3']);
//             Access this ^ item:
var positiveItem = positiveIndices[1]; // 1
var negativeItem = negativeIndices[-3]; // 1

You can use negative indices on all new and existing methods of $List and $Iterable.

slice

Get a sublist of the collection:

var list = $([0, 1, 2, 3, 4, 5]);
var last = list.slice(-1); // [5]
var lastHalf = list.slice(3); // [3, 4, 5]
var allButFirstAndLast = list.slice(1,-2); // [1, 2, 3, 4]

sortedBy & thenBy

Sort lists by multiple properties

class Dog {
    String name;
    String age;

    Dog(this.name, this.age);
}

var dogs = $();
dogs.add(Dog("Tom", 3));
dogs.add(Dog("Charlie", 7));
dogs.add(Dog("Charlie", 2));
dogs.add(Dog("Cookie", 4));
dogs.add(Dog("Bark", 1));

var sorted = dogs
    .sortedBy((dog) => dog.name)
    .thenByDescending((dog) => dog.age);
// Bark, Cookie, Charlie (7), Charlie (2), Tom

contentEquals

Compare two lists:

var list = $(['some', 'items']);
var equals1 = list.contentEquals(['some', 'items']); // true
var equals2 = list.contentEquals(['SOME', 'items']); // false

minBy & maxBy

Get the smallest or largest element from a list:

//Take dogs list from example above
var firstDogByName = dogs.minBy((dog) => dog.name); // Bark
var oldestDog = dogs.maxBy((dog) => dog.age); // Charlie

distinctBy

Get distinct elements from a list:

//Take dogs list from example above
var dogNames = dogs
    .distinctBy((dog) => dog.name)
    .map((dog) => dog.name);
// ['Tom', 'Charlie', 'Cookie', 'Bark']

flatten

Flatten a list of iterables:

var nestedList = $List([[1, 2, 3], [4, 5, 6]]);
var flattened = nestedList.flatten(); // [1, 2, 3, 4, 5, 6]

firstOrNull & firstOrNullWhere

Find the first element of the collection matching a predicate:

var list = $(['This', 'is', 'a', 'Test']);
var first = list.firstOrNull; // 'This'
var firstWhere = list.firstOrNullWhere((s) => s.length <= 2); // 'is'
var firtNull = list.firstOrNullWhere((s) => s.length > 4); // null

elementAtOrNull & elementAtOrElse

Get the element at an index or null if the index does not exist:

var list = $([0, 1, 2, 3, 4, 5, 6]);
var second = list.elementAtOrNull(1); // 1
var highIndexNull = list.elementAtOrNull(10); // null
var highIndexDefault = list.elementAtOrDefault(10, -1); // -1

many more superpowers

There are many more handy superpowers (like intersect(), groupBy() and associateWith()) available. Take a look at the Documentation.

$List, $Iterable and $Map 🦄

The wrappers for Lists, Iterables and Maps are $List, $Iterable and $Map they behave as you would expect them to. ($Iterable is lazy loading while $List is not).

There is no need to work with the unwrapped classes. The wrapper classes have the exact same performance as their native counterparts.

Important: Always remember that $List, $Iterable and $Map are wrappers. This means if you remove an item from a $List, it will also be removed from the source list.

var source = [0, 1, 2, 3];

var superList = $(source);
superList.add(4);
//source: [0, 1, 2, 3, 4]

var independantList = $(source).toList();
independantList.add(5);
//source: [0, 1, 2, 3, 4]

Features and bugs

Please file feature requests and bugs at the issue tracker.

Todo ✏️

  • ✔️ most important features for collections
  • ✔️ superpowers for Map
  • even more tests
  • superpowers for other classes?
  • more features for collections
  • more samples in the docs

MIT License

Copyright (c) 2018 Simon Leier

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.