PIXU format

TECR encode path. Prefer format: 'image/pixu' on compress. The output file is always WebP or JPEG with a known extension.

Constants

import {
  PIXU_MIME_TYPE,   // 'image/pixu' — encode option only
  isPixuSupported,
  buildDownloadName,
} from '@pantanal/pixu'

isPixuSupported() // true

PIXU_EXTENSION is deprecated (alias of .webp). Prefer buildDownloadName(name, result.format).

Deprecated aliases still exported: PIX_MIME_TYPE, PIX_EXTENSION, isPixSupported, canvasToPix, estimatePixCompression.

canvasToPixu

function canvasToPixu(
  canvas: HTMLCanvasElement,
  quality?: number,
  options?: {
    progressive?: boolean
    adaptive?: boolean
    chromaSubsampling?: '4:4:4' | '4:2:2' | '4:2:0'
  }
): Promise<Blob>

Returns a Blob typed as image/webp (or image/jpeg fallback). Default quality is 0.85. adaptive defaults to true.

estimatePixuCompression

function estimatePixuCompression(
  originalSize: number,
  quality: number,
  width: number,
  height: number
): number

Returns an estimated compression ratio (roughly 0.4–0.8 depending on inputs).

normalizePixuFormat

function normalizePixuFormat(format: string): string

Maps legacy 'image/pix' → 'image/pixu'.

Example

import { compress, PIXU_MIME_TYPE, buildDownloadName } from '@pantanal/pixu'

const result = await compress(file, {
  format: PIXU_MIME_TYPE,
  enableSmartQuality: true,
})

// result.format === 'image/webp' | 'image/jpeg'
a.download = buildDownloadName('photo', result.format)
img.src = URL.createObjectURL(result.file)

Download helpers

import { getOutputExtension, buildDownloadName } from '@pantanal/pixu'

getOutputExtension('image/webp')  // '.webp'
getOutputExtension('image/jpeg')  // '.jpg'
getOutputExtension('image/pixu')  // '.webp' (encode option → default container)
buildDownloadName('photo', result.format)  // matches payload

Legacy preview helpers

For older blobs still typed as image/pixu:

import {
  createPreviewObjectURL,
  pixuToDisplayBlob,
  loadPixuImage,
  detectPixuPayloadMime,
} from '@pantanal/pixu'

See PIXU encode.

Related

• Guide: PIXU Format
• Guide: PIXU encode
• Theory: TECR