API Reference
Result
Reference for the BlurResult returned by encode() and encodeMany().
When to use
Section titled “When to use”Use this page when integrating blurkit output into UI components, manifests, or database records.
Example
Section titled “Example”const result = await encode('./public/hero.jpg')
console.log(result.dataURL)console.log(result.hash)console.log(result.meta.originalWidth)Inputs / Options / Behavior
Section titled “Inputs / Options / Behavior”interface BlurResult { dataURL: string hash: string algorithm: 'blurhash' | 'thumbhash' width: number height: number meta: { originalWidth: number originalHeight: number format?: string hasAlpha?: boolean }}dataURLis the direct placeholder value for UI props.hashpreserves algorithm output for storage or post-processing.width/heightreflect placeholder dimensions.metadescribes source image properties when available.
Limits / Caveats
Section titled “Limits / Caveats”metais optional.- Stored
dataURLsize depends on chosenoutputFormatand dimensions.