Comparing version 0.2.13 to 0.2.14
{ | ||
"name": "lists", | ||
"version": "0.2.13", | ||
"version": "0.2.14", | ||
"description": "A library of higher-order functions modeled after Haskell's Data.List module", | ||
@@ -5,0 +5,0 @@ "main": "lists.min.js", |
582
README.md
@@ -260,5 +260,5 @@ # [ l [ i [ s ] t ] s ] | ||
------ | ||
<a name='append'/> | ||
### append : [x]|str -> [x]|str|num -> [x]|str | ||
------ | ||
<a name='append'></a> | ||
## append : [x]|str -> [x]|str|num -> [x]|str | ||
**Description**: A prefix-style Array.prototype.concat wrapper. | ||
@@ -276,5 +276,5 @@ | ||
------ | ||
<a name='head'/> | ||
### head : [x]|str -> x | ||
------ | ||
<a name='head'></a> | ||
## head : [x]|str -> x | ||
**Description**: Retreive the first element of an Array of Variables or a String. | ||
@@ -292,5 +292,5 @@ | ||
------ | ||
<a name='last'/> | ||
### last : [x]|str -> x | ||
------ | ||
<a name='last'></a> | ||
## last : [x]|str -> x | ||
**Description**: Retreive the last element of an Array of Variables or a String. | ||
@@ -308,5 +308,5 @@ | ||
------ | ||
<a name='init'/> | ||
### init : [x]|str -> [x] | ||
------ | ||
<a name='init'></a> | ||
## init : [x]|str -> [x] | ||
**Description**: Retreive all elements except the last of an Array of Variables or a String. | ||
@@ -324,5 +324,5 @@ | ||
------ | ||
<a name='tail'/> | ||
### tail : [x]|str -> [x] | ||
------ | ||
<a name='tail'></a> | ||
## tail : [x]|str -> [x] | ||
**Description**: Retreive all elements except the first of an Array of Variables or a String. | ||
@@ -340,5 +340,5 @@ | ||
------ | ||
<a name='nil'/> | ||
### nil : [x]|str -> boolean | ||
------ | ||
<a name='nil'></a> | ||
## nil : [x]|str -> boolean | ||
**Description**: Test if an Array of Variables or a String is empty. | ||
@@ -358,5 +358,5 @@ | ||
------ | ||
<a name='map'/> | ||
### map : [x]|str -> f -> [x] | ||
------ | ||
<a name='map'></a> | ||
## map : [x]|str -> f -> [x] | ||
**Description**: Array of Variables returned by applying f to each element of an Array of Variables or a String. | ||
@@ -376,5 +376,5 @@ | ||
------ | ||
<a name='rev'/> | ||
### rev : [x]|str -> [x] | ||
------ | ||
<a name='rev'></a> | ||
## rev : [x]|str -> [x] | ||
**Description**: Array of Variables returned by reversing the order of each element of an Array of Variables or a String. | ||
@@ -392,5 +392,5 @@ | ||
------ | ||
<a name='intersperse'/> | ||
### intersperse : x -> [x]|str -> [x]|str | ||
------ | ||
<a name='intersperse'></a> | ||
## intersperse : x -> [x]|str -> [x]|str | ||
**Description**: Array of Variables or a String returned by interspersing a given separator between elements of a given Array. | ||
@@ -409,5 +409,5 @@ | ||
------ | ||
<a name='intercalate'/> | ||
### intercalate : [x] -> [[x]] -> [x] | ||
------ | ||
<a name='intercalate'></a> | ||
## intercalate : [x] -> [[x]] -> [x] | ||
**Description**: Array of Variables returned by flattening the result of interspersing an Array of Variables into an Array of an Array of Variables. | ||
@@ -425,5 +425,5 @@ | ||
------ | ||
<a name='transpose'/> | ||
### transpose : [[x]] -> [[x]] | ||
------ | ||
<a name='transpose'></a> | ||
## transpose : [[x]] -> [[x]] | ||
**Description**: Array of an Array of Variables returned by transposing rows and columns of given arguments. | ||
@@ -440,5 +440,5 @@ | ||
------ | ||
<a name='subsequences'/> | ||
### subsequences : [x]|str -> [[x]] | ||
------ | ||
<a name='subsequences'></a> | ||
## subsequences : [x]|str -> [[x]] | ||
**Description**: Array of an Array of Variables of all subsequences of a given arguement. | ||
@@ -455,5 +455,5 @@ | ||
------ | ||
<a name='permutations'/> | ||
### permutations : [x]|str -> [[x]]|[str] | ||
------ | ||
<a name='permutations'></a> | ||
## permutations : [x]|str -> [[x]]|[str] | ||
**Description**: Array of an Array of Variables or Array of Strings returned by getting all permutations of a given arguement. | ||
@@ -470,5 +470,5 @@ | ||
------ | ||
<a name='foldl'/> | ||
### foldl : x -> [x]|str -> f -> x | ||
------ | ||
<a name='foldl'></a> | ||
## foldl : x -> [x]|str -> f -> x | ||
**Description**: Variable returned reducing left to right by applying a binary operator Function (f) on a starting Variable (x), known as the accumulator, and an Array of Variables or a String. | ||
@@ -486,5 +486,5 @@ | ||
------ | ||
<a name='foldl1'/> | ||
### foldl1 : [x]|str -> f -> x | ||
------ | ||
<a name='foldl1'></a> | ||
## foldl1 : [x]|str -> f -> x | ||
**Description**: Variant of foldl without a starting Variable (The accumulator begins with the 0th index of the passed Array of Variables or a String). Use with non-empty Arrays or Strings. | ||
@@ -501,5 +501,5 @@ | ||
------ | ||
<a name='foldr'/> | ||
### foldr : x -> [x]|str -> f -> x | ||
------ | ||
<a name='foldr'></a> | ||
## foldr : x -> [x]|str -> f -> x | ||
**Description**: Variable returned reducing right to left by applying a binary operator Function (f) on a starting Variable (x), known as the accumulator, and an Array of Variables or a String. | ||
@@ -518,5 +518,5 @@ | ||
------ | ||
<a name='foldr1'/> | ||
### foldr1 : [x]|str -> f -> x | ||
------ | ||
<a name='foldr1'></a> | ||
## foldr1 : [x]|str -> f -> x | ||
**Description**: Variant of foldr without a starting Variable (The accumulator begins with the 0th index of the passed Array or a String). Use with non-empty Arrays or Strings. | ||
@@ -533,5 +533,5 @@ | ||
------ | ||
<a name='flatten'/> | ||
### flatten || concat : [[x]]|[str] -> [x]|str | ||
------ | ||
<a name='flatten'></a> | ||
## flatten || concat : [[x]]|[str] -> [x]|str | ||
**Description**: Flatten an Array of an Array of Variables or an Array of Strings into an Array of Variables or a String respectively. | ||
@@ -548,5 +548,5 @@ | ||
------ | ||
<a name='concatMap'/> | ||
### concatMap : [x]|str -> f -> [x]|str | ||
------ | ||
<a name='concatMap'></a> | ||
## concatMap : [x]|str -> f -> [x]|str | ||
**Description**: Array of Variables or a String returned by mapping a Function over an Array of Variables or a String and flattening the result. | ||
@@ -567,5 +567,5 @@ | ||
------ | ||
<a name='and'/> | ||
### and : [boolean] -> boolean | ||
------ | ||
<a name='and'></a> | ||
## and : [boolean] -> boolean | ||
**Description**: Boolean returned by the conjunction of an Array of booleans. True if all booleans are true. False if one or more booleans is false. | ||
@@ -582,5 +582,5 @@ | ||
------ | ||
<a name='or'/> | ||
### or : [boolean] -> boolean | ||
------ | ||
<a name='or'></a> | ||
## or : [boolean] -> boolean | ||
**Description**: Boolean returned by the disjunction of an Array of booleans. True if at least one boolean is true. False if all booleans are false. | ||
@@ -597,5 +597,5 @@ | ||
------ | ||
<a name='any'/> | ||
### any : [x]|str -> f -> boolean | ||
------ | ||
<a name='any'></a> | ||
## any : [x]|str -> f -> boolean | ||
**Description**: Boolean returned by applying a predicate Function to each element in an Array of Variables or a String. True if at least one f(x) is true. False if all f(x) are false. | ||
@@ -612,5 +612,5 @@ | ||
------ | ||
<a name='all'/> | ||
### all : [x]|str -> f -> boolean | ||
------ | ||
<a name='all'></a> | ||
## all : [x]|str -> f -> boolean | ||
**Description**: Boolean returned by applying a predicate Function to each element in an Array of Variables or a String. True if all f(x) are true. False if any f(x) are false. | ||
@@ -628,5 +628,5 @@ | ||
------ | ||
<a name='sum'/> | ||
### sum : [num] -> num | ||
------ | ||
<a name='sum'></a> | ||
## sum : [num] -> num | ||
**Description**: Number returned by summing the numbers of an Array together. | ||
@@ -643,5 +643,5 @@ | ||
------ | ||
<a name='product'/> | ||
### product : [num] -> num | ||
------ | ||
<a name='product'></a> | ||
## product : [num] -> num | ||
**Description**: Number returned by computing the product of the numbers of an Array. | ||
@@ -658,5 +658,5 @@ | ||
------ | ||
<a name='maximum'/> | ||
### maximum : [num] -> num | ||
------ | ||
<a name='maximum'></a> | ||
## maximum : [num] -> num | ||
**Description**: Maximum Number returned from numbers of an Array. | ||
@@ -673,5 +673,5 @@ | ||
------ | ||
<a name='minimum'/> | ||
### minimum : [num] -> num | ||
------ | ||
<a name='minimum'></a> | ||
## minimum : [num] -> num | ||
**Description**: Minimum Number returned from numbers of an Array. | ||
@@ -688,5 +688,5 @@ | ||
------ | ||
<a name='maxList'/> | ||
### maxList : [[x]] -> [x] | ||
------ | ||
<a name='maxList'></a> | ||
## maxList : [[x]] -> [x] | ||
**Description**: Array of Variables with the maximum length returned from an Array of an Array of Variables. | ||
@@ -703,5 +703,5 @@ | ||
------ | ||
<a name='minList'/> | ||
### minList : [[x]] -> [x] | ||
------ | ||
<a name='minList'></a> | ||
## minList : [[x]] -> [x] | ||
**Description**: Array of Variables with the minimum length returned from an Array of an Array of Variables. | ||
@@ -718,5 +718,5 @@ | ||
------ | ||
<a name='scanl'/> | ||
### scanl : x -> [x]|str -> f -> [x] | ||
------ | ||
<a name='scanl'></a> | ||
## scanl : x -> [x]|str -> f -> [x] | ||
**Description**: Array of Variables returned building left to right, starting with the accumulator (x) by applying a binary operator Function (f) on a starting Variable (x) and an Array of Variables or a String. | ||
@@ -733,5 +733,5 @@ | ||
------ | ||
<a name='scanr'/> | ||
### scanr : x -> [x]|str -> f -> [x] | ||
------ | ||
<a name='scanr'></a> | ||
## scanr : x -> [x]|str -> f -> [x] | ||
**Description**: Array of Variables returned building right to left, starting with the accumulator (x) by applying a binary operator Function (f) on a starting Variable (x) and an Array of Variables or a String. | ||
@@ -748,5 +748,5 @@ | ||
------ | ||
<a name='mapAccumL'/> | ||
### mapAccumL : x -> [x]|str -> f -> [x, [x]] | ||
------ | ||
<a name='mapAccumL'></a> | ||
## mapAccumL : x -> [x]|str -> f -> [x, [x]] | ||
**Description**: Builds an Array containing a accumulator (x) and the result of applying F to the supplied accumulator and each element of the supplied Array from left to right. | ||
@@ -764,5 +764,5 @@ | ||
------ | ||
<a name='mapAccumR'/> | ||
### mapAccumR : x -> [x]|str -> f -> [x, [x]] | ||
------ | ||
<a name='mapAccumR'></a> | ||
## mapAccumR : x -> [x]|str -> f -> [x, [x]] | ||
**Description**: Builds an Array containing a accumulator (x) and the result of applying f to the supplied accumulator and each element of the supplied Array from right to left. | ||
@@ -780,5 +780,5 @@ | ||
------ | ||
<a name='iterate'/> | ||
### iterate : x -> num -> f -> [x] | ||
------ | ||
<a name='iterate'></a> | ||
## iterate : x -> num -> f -> [x] | ||
**Description**: Builds an Array containing the successive application of f to the previous result of f(x) until the stop (num) reaches 0. | ||
@@ -796,5 +796,5 @@ | ||
------ | ||
<a name='replicate'/> | ||
### replicate : x -> num -> [x] | ||
------ | ||
<a name='replicate'></a> | ||
## replicate : x -> num -> [x] | ||
**Description**: Builds an Array containing replications of x until the stop (num) reaches 0. | ||
@@ -812,5 +812,5 @@ | ||
------ | ||
<a name='cycle'/> | ||
### cycle : [x]|str -> num -> [x]|str | ||
------ | ||
<a name='cycle'></a> | ||
## cycle : [x]|str -> num -> [x]|str | ||
**Description**: Builds an Array containing replications of a flattened Array of Variables or a String until the stop (num) reaches 0. | ||
@@ -827,5 +827,5 @@ | ||
------ | ||
<a name='unfold'/> | ||
### unfold : f -> f -> f -> x -> [x]|str | ||
------ | ||
<a name='unfold'></a> | ||
## unfold : f -> f -> f -> x -> [x]|str | ||
**Description**: Builds an Array from a seed value. Arg 1 is the predicate Function. If the predicate fails, return an empty Array, otherwise concatenate the result of Arg 2 (f) applied to Arg 4 (x) to the recursive call of unfold calling Arg 3 (f) to Arg 4 (x). This is a corecursive anamorphism. | ||
@@ -853,5 +853,5 @@ | ||
------ | ||
<a name='take'/> | ||
### take : num -> [x]|str -> [x] | ||
------ | ||
<a name='take'></a> | ||
## take : num -> [x]|str -> [x] | ||
**Description**: Array of Variables returned by taking the first n (num) elements from an Array of Variables or a String. | ||
@@ -868,5 +868,5 @@ | ||
------ | ||
<a name='drop'/> | ||
### drop : num -> [x]|str -> [x] | ||
------ | ||
<a name='drop'></a> | ||
## drop : num -> [x]|str -> [x] | ||
**Description**: Array of Variables returned by dropping the first n (num) elements from an Array of Variables or a String. | ||
@@ -883,5 +883,5 @@ | ||
------ | ||
<a name='splitAt'/> | ||
### splitAt : num -> [x]|str -> [[x],[x]] | ||
------ | ||
<a name='splitAt'></a> | ||
## splitAt : num -> [x]|str -> [[x],[x]] | ||
**Description**: Array of two Arrays returned. The first Array contains the first n elements of the supplied Array of Variables or a String. The second contains the rest. | ||
@@ -898,5 +898,5 @@ | ||
------ | ||
<a name='takeWhile'/> | ||
### takeWhile : f -> [x]|str -> [x] | ||
------ | ||
<a name='takeWhile'></a> | ||
## takeWhile : f -> [x]|str -> [x] | ||
**Description**: Array of Variables returned by taking elements from an Array of Variables or a String that satisfy a supplied predicate Function until that predicate Function is unsatisfied. | ||
@@ -914,5 +914,5 @@ | ||
------ | ||
<a name='dropWhile'/> | ||
### dropWhile : f -> [x]|str -> [x] | ||
------ | ||
<a name='dropWhile'></a> | ||
## dropWhile : f -> [x]|str -> [x] | ||
**Description**: Array of Variables returned by dropping elements from an Array of Variables or a String that satisfy a supplied predicate Function until that predicate Function is unsatisfied. | ||
@@ -930,5 +930,5 @@ | ||
------ | ||
<a name='span'/> | ||
### span : [x]|str -> f -> [[x], [x]|str] | ||
------ | ||
<a name='span'></a> | ||
## span : [x]|str -> f -> [[x], [x]|str] | ||
**Description**: An Array of an Array of Variables and Array of Variables or a String (psuedo-tuple) is returned. The first element is the longest prefix of an Array of Variables or a String that satisfy a predicate Function f. The second element is the rest of the list. | ||
@@ -946,5 +946,5 @@ | ||
------ | ||
<a name='break'/> | ||
### break : [x]|str -> f -> [[x], [x]|str] | ||
------ | ||
<a name='break'></a> | ||
## break : [x]|str -> f -> [[x], [x]|str] | ||
**Description**: An Array of an Array of Variables and Array of Variables or a String (psuedo-tuple) is returned. The first element is the longest prefix of an Array of Variables or a String that do not satisfy a predicate Function f. The second element is the rest of the list. | ||
@@ -962,5 +962,5 @@ | ||
------ | ||
<a name='stripPrefix'/> | ||
### stripPrefix : [num]|str -> [num]|str -> [num]|[str] | ||
------ | ||
<a name='stripPrefix'></a> | ||
## stripPrefix : [num]|str -> [num]|str -> [num]|[str] | ||
**Description**: Argument 1 is the prefix. Argument 2 is the target. The arguments must be of the same type. This function drops the prefix from the target and returns the representation as an Array of Numbers or an Array of Strings. | ||
@@ -977,5 +977,5 @@ | ||
------ | ||
<a name='group'/> | ||
### group : [num]|str -> [[num]]|[[str]] | ||
------ | ||
<a name='group'></a> | ||
## group : [num]|str -> [[num]]|[[str]] | ||
**Description**: An Array of an Array of Numbers or Strings returned where each nested Array contains only equal elements. | ||
@@ -992,5 +992,5 @@ | ||
------ | ||
<a name='inits'/> | ||
### inits : [x]|str -> [[x]] | ||
------ | ||
<a name='inits'></a> | ||
## inits : [x]|str -> [[x]] | ||
**Description**: An Array of an Array of Variables returned with all the initial segments of the argument, shortest first. | ||
@@ -1008,5 +1008,5 @@ | ||
------ | ||
<a name='tails'/> | ||
### tails : [x]|str -> [[x]] | ||
------ | ||
<a name='tails'></a> | ||
## tails : [x]|str -> [[x]] | ||
**Description**: An Array of an Array of Variables returned with all the initial segments of the argument, longest first. | ||
@@ -1024,5 +1024,5 @@ | ||
------ | ||
<a name='isPrefixOf'/> | ||
### isPrefixOf : [num]|str -> [num]|str -> boolean | ||
------ | ||
<a name='isPrefixOf'></a> | ||
## isPrefixOf : [num]|str -> [num]|str -> boolean | ||
**Description**: Test if an Array of Numbers or a String is the prefix of an Array of Numbers or a String. The arguments must be of the same type. | ||
@@ -1040,5 +1040,5 @@ | ||
------ | ||
<a name='isSuffixOf'/> | ||
### isSuffixOf : [num]|str -> [num]|str -> boolean | ||
------ | ||
<a name='isSuffixOf'></a> | ||
## isSuffixOf : [num]|str -> [num]|str -> boolean | ||
**Description**: Test if an Array of Numbers or a String is the suffix of an Array of Numbers or a String. The arguments must be of the same type. | ||
@@ -1056,5 +1056,5 @@ | ||
------ | ||
<a name='isInfixOf'/> | ||
### isInfixOf : [num]|str -> [num]|str -> boolean | ||
------ | ||
<a name='isInfixOf'></a> | ||
## isInfixOf : [num]|str -> [num]|str -> boolean | ||
**Description**: Test if an Array of Numbers or a String is the infix of an Array of Numbers or a String. The arguments must be of the same type. | ||
@@ -1072,5 +1072,5 @@ | ||
------ | ||
<a name='isSubsequenceOf'/> | ||
### isSubsequenceOf : [num]|str -> [num]|str -> boolean | ||
------ | ||
<a name='isSubsequenceOf'></a> | ||
## isSubsequenceOf : [num]|str -> [num]|str -> boolean | ||
**Description**: Test if an Array of Numbers or a String is the subsequence of an Array of Numbers or a String. The arguments must be of the same type. | ||
@@ -1088,5 +1088,5 @@ | ||
------ | ||
<a name='elem'/> | ||
### elem : num|str -> [num]|str -> boolean | ||
------ | ||
<a name='elem'></a> | ||
## elem : num|str -> [num]|str -> boolean | ||
**Description**: Test if the Number or a String is in the Array of Numbers or a String. | ||
@@ -1103,5 +1103,5 @@ | ||
------ | ||
<a name='notElem'/> | ||
### notElem : num|str -> [num]|str -> boolean | ||
------ | ||
<a name='notElem'></a> | ||
## notElem : num|str -> [num]|str -> boolean | ||
**Description**: Test if the Number or a String is not in the Array of Numbers or a String. | ||
@@ -1118,5 +1118,5 @@ | ||
------ | ||
<a name='lookup'/> | ||
### lookup : num|str -> [[num|str,x]] -> boolean | ||
------ | ||
<a name='lookup'></a> | ||
## lookup : num|str -> [[num|str,x]] -> boolean | ||
**Description**: Retreive the value of a key in an Array of an Array of Variables where position 0 is the key and position 1 is the value (associative array). | ||
@@ -1134,5 +1134,5 @@ | ||
------ | ||
<a name='find'/> | ||
### find : [x]|str -> f -> x | ||
------ | ||
<a name='find'></a> | ||
## find : [x]|str -> f -> x | ||
**Description**: Retreive a Variable by applying a predicate Function to an Array of Variables or a String. Returns "Nothing" if there is no match. | ||
@@ -1150,5 +1150,5 @@ | ||
------ | ||
<a name='filter'/> | ||
### filter : [x]|str -> f -> [x] | ||
------ | ||
<a name='filter'></a> | ||
## filter : [x]|str -> f -> [x] | ||
**Description**: An Array of Variables returned by applying a predicate Function to an Array of Variables or a String. | ||
@@ -1166,5 +1166,5 @@ | ||
------ | ||
<a name='partition'/> | ||
### partition : [x]|str -> f -> [[x],[x]] | ||
------ | ||
<a name='partition'></a> | ||
## partition : [x]|str -> f -> [[x],[x]] | ||
**Description**: An Array of two Arrays of Variables returned by applying a predicate Function to an Array of Variables. The Array of Variables at position 0 are the Variables that satisfy the predicate Function. The Array of Variables at position 1 are the Variables that do not satisfy the predicate Function. | ||
@@ -1182,5 +1182,5 @@ | ||
------ | ||
<a name='bang'/> | ||
### bang : num -> [x] -> x | ||
------ | ||
<a name='bang'></a> | ||
## bang : num -> [x] -> x | ||
**Description**: Variable returned by fetching the Variable at the given index (Number). | ||
@@ -1198,5 +1198,5 @@ | ||
------ | ||
<a name='elemIndex'/> | ||
### elemIndex || indexOf : num|str -> [num]|str -> num | ||
------ | ||
<a name='elemIndex'></a> | ||
## elemIndex || indexOf : num|str -> [num]|str -> num | ||
**Description**: Returns the index Number of the first occurance of a Number or a String from an Array of Numbers or a String. | ||
@@ -1214,5 +1214,5 @@ | ||
------ | ||
<a name='elemIndices'/> | ||
### elemIndices : num|str -> [num]|str -> [num] | ||
------ | ||
<a name='elemIndices'></a> | ||
## elemIndices : num|str -> [num]|str -> [num] | ||
**Description**: Returns an Array of Numbers representing the indices of the Number or a String from an Array of Numbers or a String. | ||
@@ -1230,5 +1230,5 @@ | ||
------ | ||
<a name='findIndex'/> | ||
### findIndex : [x]|str -> f -> num | ||
------ | ||
<a name='findIndex'></a> | ||
## findIndex : [x]|str -> f -> num | ||
**Description**: Returns the index Number of the first occurance of the result of applying a predicate Function to an Array of Variables or a String. | ||
@@ -1246,5 +1246,5 @@ | ||
------ | ||
<a name='findIndices'/> | ||
### findIndices : [x]|str -> f -> [num] | ||
------ | ||
<a name='findIndices'></a> | ||
## findIndices : [x]|str -> f -> [num] | ||
**Description**: Returns an Array of Numbers representing the indices of the result of applying a predicate Function to an Array of Variables or a String. | ||
@@ -1262,5 +1262,5 @@ | ||
------ | ||
<a name='zip'/> | ||
### zip || unzip : [[a,b,..,n],[c,d,..,n],..,n] -> [[a,c,..,n],[b,d,..,n],..,n] | ||
------ | ||
<a name='zip'></a> | ||
## zip || unzip : [[a,b,..,n],[c,d,..,n],..,n] -> [[a,c,..,n],[b,d,..,n],..,n] | ||
**Description**: Takes an Array of an Array of Variables and returns an Array of an Array of Variables with corresponding Variables. | ||
@@ -1278,5 +1278,5 @@ | ||
------ | ||
<a name='zipWith'/> | ||
### zipWith : [[a,b,..,n],[c,d,..,n],..,n] -> f -> [x] | ||
------ | ||
<a name='zipWith'></a> | ||
## zipWith : [[a,b,..,n],[c,d,..,n],..,n] -> f -> [x] | ||
**Description**: Takes an Array of an Array of Variables and a Function and returns an Array of Variables with the results being the Function applied to the corresponding zipped Array of Variables. | ||
@@ -1301,5 +1301,5 @@ | ||
------ | ||
<a name='lines'/> | ||
### lines : str -> [str] | ||
------ | ||
<a name='lines'></a> | ||
## lines : str -> [str] | ||
**Description**: Returns an Array of Strings as the result of breaking a String at each new line character (\u000A). The resultant Array does not contain any new line characters. | ||
@@ -1316,5 +1316,5 @@ | ||
------ | ||
<a name='words'/> | ||
### words : str -> [str] | ||
------ | ||
<a name='words'></a> | ||
## words : str -> [str] | ||
**Description**: Returns an Array of Strings as the result of breaking a String at each space character (\u0020). The resultant Array does not contain any space characters. | ||
@@ -1330,5 +1330,5 @@ | ||
------ | ||
<a name='unlines'/> | ||
### unlines : [str] -> str | ||
------ | ||
<a name='unlines'></a> | ||
## unlines : [str] -> str | ||
**Description**: Returns a String with a new line character appended to each String of the Array that it joins. | ||
@@ -1344,5 +1344,5 @@ | ||
------ | ||
<a name='unwords'/> | ||
### unwords : [str] -> str | ||
------ | ||
<a name='unwords'></a> | ||
## unwords : [str] -> str | ||
**Description**: Returns a String with a space character appended to each String of the Array that it joins. | ||
@@ -1358,5 +1358,5 @@ | ||
------ | ||
<a name='nub'/> | ||
### nub || uniq || unique : [num|str]|str -> [num|str] | ||
------ | ||
<a name='nub'></a> | ||
## nub || uniq || unique : [num|str]|str -> [num|str] | ||
**Description**: Remove duplicates from a String or an Array of Numbers and/or Strings. Keep the first occurence of each element. | ||
@@ -1374,5 +1374,5 @@ | ||
------ | ||
<a name='delete'/> | ||
### delete : x -> [x]|str -> [x] | ||
------ | ||
<a name='delete'></a> | ||
## delete : x -> [x]|str -> [x] | ||
**Description**: Return an Array of Variables from the result of removing the first occurence of a Variable from an Array of Variables or a String. Does not work with Objects. | ||
@@ -1390,5 +1390,5 @@ | ||
------ | ||
<a name='difference'/> | ||
### difference || diff : [num|str]|str -> [num|str]|str -> [x] | ||
------ | ||
<a name='difference'></a> | ||
## difference || diff : [num|str]|str -> [num|str]|str -> [x] | ||
**Description**: Return an Array of Variables whose elements are the difference between Argument 1 and Argument 2. | ||
@@ -1406,5 +1406,5 @@ | ||
------ | ||
<a name='union'/> | ||
### union : [num|str]|str -> [num|str]|str -> [x]|str | ||
------ | ||
<a name='union'></a> | ||
## union : [num|str]|str -> [num|str]|str -> [x]|str | ||
**Description**: Return an Array of Variables whose elements are the union between Argument 1 and Argument 2. | ||
@@ -1421,5 +1421,5 @@ | ||
------ | ||
<a name='intersect'/> | ||
### intersect : [num|str]|str -> [num|str]|str -> [x] | ||
------ | ||
<a name='intersect'></a> | ||
## intersect : [num|str]|str -> [num|str]|str -> [x] | ||
**Description**: Return an Array of Variables whose elements are the intersection between Argument 1 and Argument 2. | ||
@@ -1436,5 +1436,5 @@ | ||
------ | ||
<a name='sort'/> | ||
### sort : [x]|str -> [x] | ||
------ | ||
<a name='sort'></a> | ||
## sort : [x]|str -> [x] | ||
**Description**: Return an Array of Variables that are sorted by the Ordering Function `lists.compare`. | ||
@@ -1452,5 +1452,5 @@ | ||
------ | ||
<a name='insert'/> | ||
### insert : x -> [x] -> [x] | ||
------ | ||
<a name='insert'></a> | ||
## insert : x -> [x] -> [x] | ||
**Description**: Inserts an element into the first position of the Array of Variables where the element is less than or equal (defined by `lists.compare`) to the Variable from the Array it is being compared to. | ||
@@ -1467,5 +1467,5 @@ | ||
------ | ||
<a name='nubBy'/> | ||
### nubBy : [x]|str -> f -> [x] | ||
------ | ||
<a name='nubBy'></a> | ||
## nubBy : [x]|str -> f -> [x] | ||
**Description**: Remove duplicates from an Array of Variables or a String based on a user supplied Function defintion of equality. Keep the first occurence of each element. | ||
@@ -1487,5 +1487,5 @@ | ||
------ | ||
<a name='deleteBy'/> | ||
### deleteBy : x -> [x]|str -> f -> [x] | ||
------ | ||
<a name='deleteBy'></a> | ||
## deleteBy : x -> [x]|str -> f -> [x] | ||
**Description**: Return an Array of Variables from the result of removing the first occurence of a Variable or a String that matches a user supplied Function definition of equality from an Array of Variables. | ||
@@ -1502,5 +1502,5 @@ | ||
------ | ||
<a name='deleteFirstsBy'/> | ||
### deleteFirstsBy : [x]|str -> [x]|str -> f -> [x] | ||
------ | ||
<a name='deleteFirstsBy'></a> | ||
## deleteFirstsBy : [x]|str -> [x]|str -> f -> [x] | ||
**Description**: Return the first Array of Variables or String passed with the first occurence of each element from the second Array of Variables or String removed based on a user supplied Function definition of equality. | ||
@@ -1517,5 +1517,5 @@ | ||
------ | ||
<a name='unionBy'/> | ||
### unionBy : [x] -> [x] -> f -> [x] | ||
------ | ||
<a name='unionBy'></a> | ||
## unionBy : [x] -> [x] -> f -> [x] | ||
**Description**: Return an Array of Variables as the union between Argument 1, Argument 2, and the user supplied Function definition of equality. | ||
@@ -1535,5 +1535,5 @@ | ||
------ | ||
<a name='intersectBy'/> | ||
### intersectBy : [x]|str -> [x]|str -> f -> [x] | ||
------ | ||
<a name='intersectBy'></a> | ||
## intersectBy : [x]|str -> [x]|str -> f -> [x] | ||
**Description**: Return an Array of Variables as the intersection between Argument 1, Argument 2, and the user supplied Function definition of equality. | ||
@@ -1549,5 +1549,5 @@ | ||
------ | ||
<a name='groupBy'/> | ||
### groupBy : [x]|str -> f -> [[x]] | ||
------ | ||
<a name='groupBy'></a> | ||
## groupBy : [x]|str -> f -> [[x]] | ||
**Description**: Return an Array of Variables where each nested Array is a group of equal elements. Equality is defined by the user supplied Function. | ||
@@ -1564,5 +1564,5 @@ | ||
------ | ||
<a name='sortBy'/> | ||
### sortBy : [x]|str -> f -> [x] | ||
------ | ||
<a name='sortBy'></a> | ||
## sortBy : [x]|str -> f -> [x] | ||
**Description**: Return an Array of Variables that are sorted based on the user supplied Ordering Function. | ||
@@ -1581,5 +1581,5 @@ | ||
------ | ||
<a name='insertBy'/> | ||
### insertBy : x -> [x]|str -> f -> [x] | ||
------ | ||
<a name='insertBy'></a> | ||
## insertBy : x -> [x]|str -> f -> [x] | ||
**Description**: Inserts an element into the first position of the Array of Variables based on the user supplied Ordering Function. | ||
@@ -1598,5 +1598,5 @@ | ||
------ | ||
<a name='maximumBy'/> | ||
### maximumBy : [x]|str -> f -> x | ||
------ | ||
<a name='maximumBy'></a> | ||
## maximumBy : [x]|str -> f -> x | ||
**Description**: The largest element of a non-empty Array of Variables or a String where the definition of "largest" comes from the user supplied Ordering function. | ||
@@ -1616,5 +1616,5 @@ | ||
------ | ||
<a name='minimumBy'/> | ||
### minimumBy : [x]|str -> f -> x | ||
------ | ||
<a name='minimumBy'></a> | ||
## minimumBy : [x]|str -> f -> x | ||
**Description**: The least element of a non-empty Array of Variables or a String where the definition of "least" comes from the user supplied Ordering function. | ||
@@ -1634,5 +1634,5 @@ | ||
------ | ||
<a name='genericExcludeChar'/> | ||
### genericExcludeChar : str -> str -> [str] | ||
------ | ||
<a name='genericExcludeChar'></a> | ||
## genericExcludeChar : str -> str -> [str] | ||
**Description**: Strips an arbitrary character (String) from a String. This function is the primary work horse of `lists.lines` and `lists.words`. | ||
@@ -1651,5 +1651,5 @@ | ||
------ | ||
<a name='each'/> | ||
### forEach || each : x -> f -> x | ||
------ | ||
<a name='each'></a> | ||
## forEach || each : x -> f -> x | ||
**Description**: An enhanced polyfill of Array.prototype.forEach. Works for properties of Objects. This function is meant to alter mutable state. | ||
@@ -1686,5 +1686,5 @@ | ||
------ | ||
<a name='keys'/> | ||
### keys : obj -> [str] | ||
------ | ||
<a name='keys'></a> | ||
## keys : obj -> [str] | ||
**Description**: A polyfill of `Object.keys`. Returns an Array of Strings representing the iterable properties of the Object not from its inherited chained properties. | ||
@@ -1700,5 +1700,5 @@ | ||
------ | ||
<a name='enum'/> | ||
### enumeration || enum : num -> num -> [num] | ||
------ | ||
<a name='enum'></a> | ||
## enumeration || enum : num -> num -> [num] | ||
**Description**: Create an enumeration in the form of an Array of Numbers where Argument 1 is the start Number and Argument 2 is the stop Number. | ||
@@ -1714,5 +1714,5 @@ | ||
------ | ||
<a name='pipe'/> | ||
### composeL || pipe : f[,..,f] -> f | ||
------ | ||
<a name='pipe'></a> | ||
## composeL || pipe : f[,..,f] -> f | ||
**Description**: Return a Function that represents the composition of Functions passed as Arguments. These Functions will be applied from rightmost to leftmost to the returned Function's Argument. | ||
@@ -1729,5 +1729,5 @@ | ||
------ | ||
<a name='sequence'/> | ||
### composeR || sequence : f[,..,f] -> f | ||
------ | ||
<a name='sequence'></a> | ||
## composeR || sequence : f[,..,f] -> f | ||
**Description**: Return a Function that represents the composition of Functions passed as Arguments. These Functions will be applied from leftmost to rightmost to the returned Function's Argument. | ||
@@ -1744,5 +1744,5 @@ | ||
------ | ||
<a name='partial'/> | ||
### partial || part : f -> x[,..,x] -> f | ||
------ | ||
<a name='partial'></a> | ||
## partial || part : f -> x[,..,x] -> f | ||
**Description**: Return a partially applied Function where any number of a Function's arguments may be left undefined using `undefined` as a filler variable to be filled when the Function is called. | ||
@@ -1760,5 +1760,5 @@ | ||
------ | ||
<a name='flip'/> | ||
### flip : f -> f | ||
------ | ||
<a name='flip'></a> | ||
## flip : f -> f | ||
**Description**: Return an equivalent Function whose arguments are 'flipped' or reversed. | ||
@@ -1775,5 +1775,5 @@ | ||
------ | ||
<a name='compare'/> | ||
### compare : x -> x -> str | ||
------ | ||
<a name='compare'></a> | ||
## compare : x -> x -> str | ||
**Description**: The only Ordering Function provided in Lists. Returns a String that is the representation of comparing both Arguments with the native JavaScript comparator operators. Ordering Functions are used to redefine how Variables are ordered. | ||
@@ -1791,5 +1791,5 @@ | ||
------ | ||
<a name='bubbleSort'/> | ||
### bubbleSort : [num] -> [num] | ||
------ | ||
<a name='bubbleSort'></a> | ||
## bubbleSort : [num] -> [num] | ||
**Description**: A generic bubblesort algorithm for sorting an Array of Numbers. | ||
@@ -1805,5 +1805,5 @@ | ||
------ | ||
<a name='mergeSort'/> | ||
### mergeSort : [num] -> [num] | ||
------ | ||
<a name='mergeSort'></a> | ||
## mergeSort : [num] -> [num] | ||
**Description**: A generic mergesort algorithm for sorting an Array of Numbers. | ||
@@ -1810,0 +1810,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
90407