Class: Builder

Helper class for change configurations and create a Vibrant instance. Methods of a Builder instance can be chained like:

Example

Vibrant.from(src)
  .quality(1)
  .clearFilters()
  // ...
  .getPalette()
  .then((palette) => {})

Constructors

new Builder()

new Builder(src, opts): Builder

Arguments are the same as Vibrant.constructor.

Parameters

src

ImageSource

opts

Partial<Options> = {}

Returns

Builder

Defined in

builder.ts:28

Methods

addFilter()

addFilter(name): Builder

Adds a filter function

Parameters

name

string

Returns

Builder

this Builder instance.

Defined in

builder.ts:55

---

build()

build(): Vibrant

Builds and returns a Vibrant instance as configured.

Returns

Vibrant

Defined in

builder.ts:127

---

clearFilters()

clearFilters(): Builder

Clear all filters.

Returns

Builder

this Builder instance.

Defined in

builder.ts:80

---

getPalette()

getPalette(): Promise<Palette>

Builds a Vibrant instance as configured and calls its getPalette method.

Returns

Promise<Palette>

Defined in

builder.ts:134

---

maxColorCount()

maxColorCount(n): Builder

Sets opts.colorCount to n.

Parameters

n

number

Returns

Builder

this Builder instance.

Defined in

builder.ts:37

---

maxDimension()

maxDimension(d): Builder

Sets opts.maxDimension to d.

Parameters

d

number

Returns

Builder

this Builder instance.

Defined in

builder.ts:46

---

quality()

quality(q): Builder

Sets opts.quality to q.

Parameters

q

number

Returns

Builder

this Builder instance.

Defined in

builder.ts:89

---

removeFilter()

removeFilter(name): Builder

Removes a filter function.

Parameters

name

string

Returns

Builder

this Builder instance.

Defined in

builder.ts:68

---

useGenerator()

useGenerator(generator, options?): Builder

Sets opts.generator to generator

Parameters

generator

string

options?

any

Returns

Builder

this Builder instance.

Defined in

builder.ts:107

---

useImageClass()

useImageClass(imageClass): Builder

Specifies which Image implementation class to use.

Parameters

imageClass

ImageClass

Returns

Builder

this Builder instance.

Defined in

builder.ts:98

---

useQuantizer()

useQuantizer(quantizer, options?): Builder

Specifies which Quantizer implementation class to use

Parameters

quantizer

string

options?

any

Returns

Builder

this Builder instance.

Defined in

builder.ts:119