Skip to content
Jonathan Potter edited this page Jun 16, 2014 · 17 revisions

toArray(xs)

Types

xs : Array-like
return : Array

Description

Convert an array-like object to a native JavaScript array.

cloneArray(xs)

cloneArray : [a] -> [a]

Types

xs : Array
return : Array

Description

Make a copy of xs.

append(xs, ys)

append : [a] -> [a] -> [a]

Types

xs : Array
ys : Array
return : Array

Description

Returns an array containing all the elements of xs and then all the elements of ys.

reverse(xs)

reverse : [a] -> [a]

Types

xs : Array
return : Array

Description

Reverses xs.

reduce(f, initVal, xs)

reduce : (b -> a -> b) -> b -> [a] -> b

Types

f : Function
initVal : Any
xs : Array
return : Any

Description

Reduce xs from left to right using the function f and the starting value of initVal. tlc.reduce(f, z, [x1, x2, x3]) is equivalent to f(f(f(z, x1), x2), x3).

reduceRight(f, initVal, xs)

reduceRight : (a -> b -> b) -> b -> [a] -> b

Types

f : Function
initVal : Any
xs : Array
return : Any

Description

Like tlc.reduce but goes from right to left. tlc.reduceRight(f, z, [x1, x2, x3]) is equivalent to f(x1, f(x2, f(x3, z))).

filter(p, xs)

filter : (a -> Boolean) -> [a] -> [a]

Types

p : Function
xs : Array
return : Array

Description

Returns an Array of all xs for which p returns true.

find(p, xs)

find : (a -> Boolean) -> [a] -> Maybe a

Types

p : Function
xs : Array
return : Maybe Any

Description

Returns [Just](API Maybe) the first element of xs for which p returns true. Otherwise returns [Nothing](API Maybe).

findIndex(p, xs)

findIndex : (a -> Boolean) -> [a] -> Maybe Int

Types

p : Function
xs : Array
return : Maybe Int

Description

Returns [Just](API Maybe) the index of the first element of xs for which p returns true. Otherwise returns [Nothing](API Maybe).

group(xs)

group : [a] -> [[a]]

Types

xs : Array
return : 2-dimensional Array

Description

Group consecutive and equal elements of xs into sub-arrays.

Example
tlc.group([1, 1, 2, 3, 3, 3]); // [[1, 1], [2], [3, 3, 3]]

groupBy(eq, xs)

groupBy : (a -> a -> Boolean) -> [a] -> [[a]]

Types

eq : boolean Function
xs : Array
return : 2-dimensional Array

Description

Like group but lets you specify an equality function.

minimum(xs)

minimum : [a] -> a

Types

xs : Array
return : Number

Assertions

xs is not empty.

Description

Returns the minimum element of xs.

maximum(xs)

maximum : [a] -> a

Types

xs : Array
return : Number

Assertions

xs is not empty.

Description

Returns the minimum element of xs.

sum(xs)

sum : [Number] -> Number

Types

xs : Array
return : Number

Description

Returns the sum of all the elements of xs.

product(xs)

product : [Number] -> Number

Types

xs : Array
return : Number

Description

Returns the product of all the elements of xs.

length(xs)

length : [a] -> Int

Types

xs : Array
return : Int

Description

Returns the length of xs.

transpose(xss)

transpose : [[a]] -> [[a]]

Types

xss : 2-dimensional Array
return : 2-dimensional Array

Description

Returns xss with the rows and columns swapped.

Example
tlc.transpose([[1, 2, 3], [4, 5, 6]]); // [[1, 4], [2, 5], [3, 6]]

zip(xs, ys)

zip : [a] -> [b] -> [(a, b)]

Types

xs : Array
ys : Array
return : 2-dimensional Array

Description

Returns a 2-dimensional array where the ith array contains the ith element of xs and ys. This is a special case of tlc.transpose.

Example
tlc.zip([1, 2, 3], [4, 5, 6]); // [[1, 4], [2, 5], [3, 6]]

zipWith(f, xs, ys)

zipWith : (a -> b -> c) -> [a] -> [b] -> [c]

Types

f : Function
xs : Array
ys : Array
return : Array

Description

Like tlc.zip except that you can specify a custom function f to combine the elements.

Example
tlc.zipWith(tlc.op['+'], [1, 2, 3], [4, 5, 6]); // [5, 7, 9]

sort(xs)

sort : [a] -> [a]

Types

xs : Array
return : Array

Description

Sorts xs.

sortBy(compare, xs)

sortBy : (a -> a -> Int) -> [a] -> [a]

Types

compare : comparison Function
xs : Array
return : Array

Description

Like tlc.sort except allows you to specify a custom comparison function.

concat(xss)

concat : [[a]] -> [a]

Types

xss : 2-dimensional Array
return : Array

Description

Flattens a 2-dimensional array into a 1-dimensional array.

Example
tlc.concat([[1, 2], [3, 4]]); // [1, 2, 3, 4]

and(xs)

and : [Boolean] -> Boolean

Types

xs : Array of Booleans
return : Boolean

Description

Returns true if all booleans in xs are true. Otherwise returns false.

or(xs)

or : [Boolean] -> Boolean

Types

xs : Array of Booleans
return : Boolean

Description

Returns true if there is at least one boolean in xs which is true. Otherwise returns false.

some(p, xs)

some : (a -> Boolean) -> [a] -> Boolean

Types

p : Function
xs : Array
return : Boolean

Description

Returns true if there is at least one element in xs for which p returns true. Otherwise returns false.

every(p, xs)

every : (a -> Boolean) -> [a] -> Boolean

Types

p : Function
xs : Array
return : Boolean

Description

Returns true if p returns true for every element in xs. Otherwise returns false.

contains(item, xs)

contains : a -> [a] -> Boolean

Types

item : Any
xs : Array
return : Boolean

Description

Returns true if xs contains item. Otherwise returns false.

range(start, stop, [step])

range : Int -> Int -> Int -> [Int]

Types

start : Integer
stop : Integer
step : Integer (optional)
return : Array

Description

Returns an array of integers starting at start and increasing by step until stop is reached. The step argument defaults to 1.

intersperse(sep, xs)

intersperse : a -> [a] -> [a]

Types

sep : Any
xs : Array
return : Array

Description

Returns an array with sep in between each of the elements of xs.

Example
tlc.intersperse(0, [1, 2, 3]); // [1, 0, 2, 0, 3]

API

  • [Array](API Array)
  • [Function](API Function)
  • [Maybe](API Maybe)
  • [Object](API Object)
  • [Set](API Set)
  • [Typeclass](API Typeclass)

Guides

  • [Operators](Guide Operators)
  • [Typeclasses](Guide Typeclasses)
  • [Replacing OOP](Guide Replacing Object Oriented Programming)

General

Clone this wiki locally