Options | blurkit

When to use

Use this page when you need predictable placeholder dimensions, algorithm selection, or output format control.

Example

import { encode } from 'blurkit/node'

await encode('./public/hero.jpg', {
  algorithm: 'thumbhash',
  width: 40,
  height: 24,
  outputFormat: 'jpeg',
})

Inputs / Options / Behavior

interface BlurKitOptions {
  algorithm?: 'blurhash' | 'thumbhash'
  size?: number
  width?: number
  height?: number
  componentX?: number
  componentY?: number
  outputFormat?: 'png' | 'jpeg'
  cache?: BlurKitCache
}

Defaults:

algorithm: blurhash
size: 32
componentX: 4
componentY: 3
outputFormat: png

Dimension behavior:

size scales longest side while preserving aspect ratio.
width only derives height from source ratio.
height only derives width from source ratio.
width + height uses exact dimensions.

Limits / Caveats

componentX and componentY only affect blurhash.
Built-in cache helper is provided via blurkit/node only.

Next read