encode()

When to use

Use encode() when one image should produce one placeholder result.

Example

import { encode } from 'blurkit/node'

const result = await encode('./public/hero.jpg', {
  algorithm: 'blurhash',
  size: 32,
  outputFormat: 'png',
})

Inputs / Options / Behavior

encode(input: BlurKitInput, options?: BlurKitOptions): Promise<BlurResult>

type BlurKitInput = string | URL | File | Blob | ArrayBuffer | Uint8Array

• Runtime entrypoint determines which input forms are valid at runtime.
• options controls algorithm, target dimensions, output format, and optional cache.
• Returns a BlurResult with dataURL, hash, dimensions, algorithm, and optional meta.
• Uint8Array input (including Node Buffer) is supported by every runtime that accepts raw bytes.
• blurkit/wasm accepts remote URL/URL/Blob/ArrayBuffer/Uint8Array and decodes PNG/JPEG/WebP.
• blurkit/deno accepts local paths, remote URL/URL/Blob/ArrayBuffer/Uint8Array with wasm-backed decode and canvas render.

Limits / Caveats

• Input support is runtime-specific.
• Remote URL input can fail from network or CORS constraints.

Next read

• API: Options
• API: Result
• Node Runtime