Skip to content

Use Cases

Build-time Manifest Generation

Precompute placeholder JSON during builds to avoid runtime encoding.

Use this pattern when your image set is known at build time and runtime latency must stay low.

Terminal window
npx blurkit encode ./public \
--glob "**/*.{jpg,jpeg,png,webp}" \
--out blur-manifest.json \
--pretty

Programmatic equivalent:

import { encodeMany, createManifest, writeManifest } from 'blurkit/node'
const inputs = ['./public/images/hero.jpg', './public/images/poster.jpg']
const results = await encodeMany(inputs, { size: 32 })
const manifest = createManifest(
Object.fromEntries(
inputs.map((path, i) => [path.replace('./public', ''), results[i]!]),
),
)
await writeManifest('./blur-manifest.json', manifest, { pretty: true })
  • Use deterministic manifest keys that match runtime image paths.
  • Build once, read many at runtime.
  • encodeMany() is fail-fast.
  • Key mismatches between manifest and app URLs break placeholder lookup.