nub/readme.markdown

Uniqueness functions

# nub

Return all the unique elements of an array. You can specify your own uniqueness
comparison function with `nub.by` too.

These work like haskell's
[`nub`](http://hackage.haskell.org/packages/archive/base/latest/doc/html/Data-List.html#v:nub)
and
[`nubBy`](http://hackage.haskell.org/packages/archive/base/latest/doc/html/Data-List.html#v:nubBy)
functions in
[Data.List](http://hackage.haskell.org/packages/archive/base/latest/doc/html/Data-List.html).

# example

``` js
$ node
> var nub = require('nub')
> nub([1,2,2,3,1,3])
[ 1, 2, 3 ]
> nub.by([ 2, 3, 5, 7, 8 ], function (x,y) { return x + y === 10 })
[ 2, 3, 5 ]
```

# methods

``` js
var nub = require('nub')
```

## nub(xs)

Return a new array with all the uniqe elements in `xs`.

Uniqueness is calculated `===` style so the types matter.

## nub.by(xs, cmp)

Use `cmp(x,y)` function to compare elements instead of the default.
`cmp` should return whether the two elements are equal as a boolean.

# install

With [npm](https://npmjs.org) do:

```
npm install nub
```

To use nub in the browser, use [browserify](http://browserify.org) or fetch a
UMD build from [browserify CDN](http://wzrd.in).

# license

MIT