byte_flow

Description:

byte flow

Byte flow #

Byte flow is a pure dart , dependency less library that provides common utility functions for lists and strings .
Contents #

Install
Functions
Array
String
TODO

Install #
dependencies:
byte_flow: ^1.0.0
copied to clipboard
After this run flutter pub get
Then import the library
import 'package:byte_flow/byte_flow.dart';
copied to clipboard
Functions #
Byte flow contains helpful utility functions for lists and strings but it's main target is to provide developers rich set of list utilites .
Array #
First import the library like this
import 'package:byte_flow/byte_flow.dart' as _;
copied to clipboard

_.chunk(List list, [int size = 1]) #
Creates an list of elements split into groups the length of size. If list can't be split evenly, the final chunk will be the remaining elements.
Example
_.chunk(['a', 'b', 'c', 'd'], 2);
// Returns ['a', 'b'],['c', 'd']

_.chunk(['a', 'b', 'c', 'd'], 3)
// Returns ['a', 'b', 'c'],['d']
copied to clipboard

_.slice(List list, [int start = 0, int end]) #
Creates a slice of list from start up to, but not including, end.
Example
_.slice([1, 2, 3, 4], 2);
// Returns [3, 4]
copied to clipboard

_.compact(List list) #
Creates an list with all falsey values removed. The values false, null,0, "", and NaN are falsey.
Example
_.compact([0, 1, false, 2, '', 3]);
// Returns [1, 2, 3]

_.compact([1, 2, 'some data', 2, '', 3, false, null]);
// Returns [1, 2, 'some data', 2, 3]
copied to clipboard

_.drop(List list, [int n = 1]) #
Creates a slice of list with n elements dropped from the beginning.
Example
_.drop([1, 2, 3]);
// Returns [2,3]

_.drop([1, 2, 3], 2);
// Returns [3]

_.drop([1, 2, 3], 5);
// Returns []

_.drop([1, 2, 3], 0);
// Returns [1, 2, 3]
copied to clipboard

_.dropRight(List list, [int n = 1]) #
Creates a slice of list with n elements dropRightped from the beginning.
Example
_.dropRight([1, 2, 3])
// Returns [1,2]
_.dropRight([1, 2, 3], 2)
// Returns [1]
_.dropRight([1, 2, 3], 5)
// Returns []
_.dropRight([1, 2, 3], 0)
// Returns [1, 2, 3]
copied to clipboard

_.fill(List list, dynamic value, [int start = 0, int end]) #
Fills elements of list with value from start up to, but not including, end.
Example
_.fill(List(3), 4);
// Returns [4, 4, 4]
copied to clipboard

_.findIndex(List list, dynamic element) #
This method uses dart's default List.indexOf()
Example
_.findIndex(["Jack", "Yash", "Adib", "Alex"], "Adib");
// Returns 2
copied to clipboard

_.findLastIndex(List list, dynamic element) #
This method finds the item in the list from right / last using dart's List.indexOf() method
Example
_.findLastIndex(["Jack", "Yash", "Adib", "Adib"], "Adib");
// Returns 0
copied to clipboard

_.head(List list) #
Finds the first element in the list Uses dart's List.first property
Example
_.head(["Dart", "Javascript", "Swift"]);
// Returns "Dart"
copied to clipboard

_.flatten(List list) #
Flatten a list , Credit goes to Justin Fagnani
Example
_.flatten([
[1, 2, 3],
['a', 'b', 'c'],
[true, false, true]
]);
// Returns [1, 2, 3, 'a', 'b', 'c', true, false, true]
copied to clipboard

_.pairs(List pairs) #
This method returns an map composed from key-value pairs.
Example
_.pairs([
['a', 1],
['b', 2]
]);
// Returns {'a': 1, 'b': 2}
copied to clipboard

`_.initial(List list)``` #
Gets all but the last element of list.
Example
_.initial([1, 2, 3]);
// Returns [1, 2]

_.initial([1, 2, 3, 'a', 'b', 'c']);
// Returns [1, 2, 3, 'a', 'b']
copied to clipboard

_.map(List list, Function(dynamic element, int index, List list) iteratee) #
Creates an list of values by running each element of list thru iteratee. The iteratee is invoked with three arguments: (value, index, list).
Example
square(n, index, list) {
return n*n;
}
_.map([4, 8], square);
// Returns [16, 64]

_.map([4, 8], (n, index, list) {
return n * 0;
});
// Returns [0, 0]
copied to clipboard

_.intersect(List<List> arrays) #
Creates an list of unique values that are included in all given arrays
Example
final lists = [
[1, 2, 3],
[2, 4, 5],
[2, 8, 9]
];
_.intersect(lists);
// Returns [2]
copied to clipboard

_.join(List list, [String separator = ',']) #
Converts all elements in list into a string separated by separator. Uses dart's List.join()
Example
_.join(['a', 'b', 'c'], '~');
// Returns 'a~b~c'
copied to clipboard

_.last(List list) #
Gets the last element of list. Uses dart's List.last property
Example
_.last(["Dart", "Javascript", "Swift"]);
// Returns "Swift"
copied to clipboard

_.nth(List list, int n) #
Gets the element at index n of list. If n is negative, the nth element from the end is returned.
Example
_.nth(['a', 'b', 'c', 'd'], 2);
// Returns 'c'

_.nth(['a', 'b', 'c', 'd'], -1);
// Returns 'd'
copied to clipboard

_.sortedIndex(List list, dynamic value) #
Uses a binary search to determine the lowest index at which value should be inserted into list in order to maintain its sort order. Returns the index at which value should be inserted into list.
Example
_.sortedIndex([30, 50], 60);
// Returns 2

_.sortedIndex([30, 50], 40);
// Returns 1

_.sortedIndex([30, 50], 30);
// Returns 0
copied to clipboard

_.tail(List list) #
Gets all but the first element of list.
Example
_.tail([1, 2, 3]);
// Returns [2, 3]
copied to clipboard

_.take(List list, [int n = 1]) #
Creates a slice of list with n elements taken from the beginning. Uses dart's native List.take(n) method
Example
_.take([1, 2, 3], 2);
// Returns [1, 2]
copied to clipboard

_.takeRight(List list, [int n = 1]) #
Creates a slice of list with n elements taken from the end.
Example
takeRight([1, 2, 3])
// => [3]
takeRight([1, 2, 3], 2)
// => [2, 3]
takeRight([1, 2, 3], 5)
// => [1, 2, 3]
takeRight([1, 2, 3], 0)
// => []
copied to clipboard

_.union(List<List> arrays) #
Creates an list of unique values, in order
Example
_.union([
[2],
[1, 2]
]);

// Returns [2, 1]
copied to clipboard

_.unzip(List list) #
This method Returns the new list of regrouped elements
Example
_.unzip([['a', 1, true], ['b', 2, false]]);
// Returns [['a', 'b'], [1, 2], [true, false]]
copied to clipboard

_.zip(List a, List b) #
Zips two arrays , Credit
Example
_.zip(['a', 'b', 'c'], [1, 2, 3]);
// Returns [['a', 1],['b', 2],['c', 3]]
copied to clipboard

_.duplicate(List list) #
Find duplicate items in an list .
Example
_.duplicate([10, 12, 9, 21, 1, 2, 10]);
// Returns [10]
copied to clipboard
String #
Byte flow libraries string utility collection is poor but still under development . The following functions are stable
_.capitalize(String text) #
Capitalizes the given string
Example
_.capitalize("hello world !");
// Returns "Hello world !"
copied to clipboard
TODO #

✅ Null safety
❌ Extension support