the input type of the function
A type representing a single-argument function.
the type of the parameter
the return type of the function
Exhausts the iterable and returns true if all elements satisfy the predicate function. This version is curried to allow for succient composition of operators.
A function that takes an iterable of type T. This function exhausts the iterable and returns true if all elements satisfy the predicate.
Exhausts the iterable and returns true if all elements satisfy the predicate function.
true if all the elements satisfy the predicate, false otherwise
Exhausts the iterable and returns true if any elements satisfy the predicate function.
A function that takes an iterable of type T. This function exhausts the iterable and returns true if any elements satisfy the predicate.
Exhausts the iterable and returns true if any elements satisfy the predicate function.
true if any element satisfy the predicate, false otherwise
dedupe
A curried verison of the dedupe operator. This overload takes no parameters and returns an operator that can be used to filter out any duplicate values in an iterable.
An iterable that contains only the first of each distinct value.
dedupe
An iterable that contains only the first of each distinct value.
drop(n)
Removes the first n elements from the iterable
A function that takes an iterable as a parameter. This function removes the first n elements from an interable
Removes the first n elements from the iterable
The first n elements from the iterable
dropWhile
Removes elements from the iterable while the predicate returns true.
A function that will consume an iterable until the predicate function returns false, then yields the rest of the iterable.
dropWhile
Removes elements from the iterable while the predicate returns true.
All elements in the source iterable after the predicate initially returns false.
enumerate
Converts a regular iterable into an indexed iterable.
Pairs, where the first value in the pair is index and the second is the value
filter
Exhausts an interable and yields only values that satisfy the prediate function.
Operates the same as the built-in Array.filter function.
A function that takes an iterable and filters it with the pred function.
filter
Exhausts an interable and yields only values that satisfy the prediate function.
Operates the same as the built-in Array.filter function.
An iterable of the values in iter that satisfy pred.
into('array')
Exhausts the source iterable and returns all values from the interable in an array.
A function that can be used to convert from the source iterable to an array
into('array', iter)
Exhausts the source iterable and returns all values from the interable in an array.
An array of all elements in the source iterable.
into('set')
Exhausts the source iterable and returns all values from the interable in an set.
A function that can be used to convert from the source iterable to set.
into('set', iter)
Exhausts the source iterable and returns all values from the interable in a set.
A set of all elements in the source iterable.
is_none
A function to determine if an object is a None object. This function is a
type assertion, to allow for strong type inference in if statements and switch statements.
an object of type Optional
true if the object is a None object, otherwise false
is_some
A function to determine if an object is a Some object. This function is a
type assertion, to allow for strong type inference in if statements and switch statements.
an object of type Optional
true if the object is a Some object, otherwise false
iterate
infinite sequence of func(seed), func(func(seed)), func(func(func(seed))), ...
none
a none object.
repeat
Produces an infinite iterable, yielding the given value over and over again
An infinite iterable of the provided value
Constructs an object of the Some type
a some object, containing the parameter as its data
Combines two iterables into a single iterable. yields pairs of values
pairs in the form [value1, value2]
Generated using TypeDoc
A type representing a predicate function.