Class: Vibrant

Main class of node-vibrant.

Constructors

new Vibrant()

new Vibrant(_src, opts?): Vibrant

Parameters

_src

ImageSource

Path to image file (supports HTTP/HTTPs)

opts?

Partial<Options>

Options (optional)

Returns

Vibrant

Defined in

index.ts:43

Properties

opts

opts: Options;

Defined in

index.ts:36

---

DefaultOpts

static DefaultOpts: Partial<Options>;

Defined in

index.ts:22

Accessors

result

Get Signature

get result(): undefined | ProcessResult

Returns

undefined | ProcessResult

Defined in

index.ts:32

Methods

getPalette()

getPalette(): Promise<Palette>

Returns

Promise<Palette>

Defined in

index.ts:61

---

getPalettes()

getPalettes(): Promise<{}>

Returns

Promise<{}>

Defined in

index.ts:83

---

from()

static from(src): Builder

Parameters

src

ImageSource

Returns

Builder

Defined in

index.ts:28

---

use()

static use(pipeline): void

Parameters

pipeline

Pipeline

Returns

void

Defined in

index.ts:18