api documentation for node-vibrant (v3.0.0-alpha.2)

Extract prominent colors from an image. Supports both node and browser environment.

table of contents

module node-vibrant
1. object node-vibrant.base
2. object node-vibrant.default
3. object node-vibrant.pqueue
module node-vibrant.base
1. function node-vibrant.base.ImageBase ()
module node-vibrant.default
1. function node-vibrant.default (r, g, b, a)
module node-vibrant.pqueue
1. function node-vibrant.pqueue.default (comparator)

module node-vibrant

module node-vibrant.base

function node-vibrant.base.ImageBase ()

description and source-code
```
function ImageBase() {
}
```
example usage
```
n/a
```

module node-vibrant.default

function node-vibrant.default (r, g, b, a)

description and source-code

function defaultFilter(r, g, b, a) {
    return a >= 125
        && !(r > 250 && g > 250 && b > 250);
}

example usage
```
n/a
```

module node-vibrant.pqueue

function node-vibrant.pqueue.default (comparator)

description and source-code

function PQueue(comparator) {
    this._comparator = comparator;
    this.contents = [];
    this._sorted = false;
}

example usage
```
n/a
```

[ this document was created with utility2 ]