@stacksjs/stx/dist/image-optimization/index.d.ts

A performant UI Framework. Powered by Bun.

/**
 * Default image configuration
 */
export declare const defaultImageConfig: ImageConfig;
/**
 * Image optimization configuration for stx.config.ts
 */
export declare interface ImageConfig {
  enabled?: boolean
  widths?: number[]
  formats?: ('webp' | 'avif' | 'jpeg' | 'png')[]
  quality?: number
  devOptimize?: boolean
  cacheDir?: string
  placeholder?: 'blur' | 'dominant-color' | 'none'
  inputDirs?: string[]
  outputDir?: string
  baseUrl?: string
}
export {
  // Core processing
  processImage,
  getImageMetadata,
  isSharpAvailable,

  // HTML helpers
  generateSrcSet,
  generateSizes,
  getFallbackVariant,
  groupVariantsByFormat,

  // Utilities
  isImageFile,
  getMimeType,
  getTotalSize,
  formatSize,

  // Error class
  ImageProcessingError,

  // Constants
  DEFAULT_WIDTHS,
  DEFAULT_FORMATS,
  DEFAULT_QUALITY,

  // Types
  type ImageOptions,
  type ImageFormat,
  type ProcessedImage,
  type ImageVariant,
  type ImageMetadata,
} from './processor';
export {
  // Rendering
  renderImageComponent,
  parseImageComponent,
  processImageComponents,

  // Types
  type ImageComponentProps,
  type ImageRenderContext,
  type ImageRenderResult,
} from './component';
export {
  // Directive
  imageDirective,
  createImageDirective,
  clearImageCache,

  // Types
  type ImageDirectiveOptions,
} from './directive';
export {
  // Plugin
  createImagePlugin,

  // Standalone functions
  optimizeImage,
  optimizeDirectory,
  generateImageManifest,
  writeImageManifest,

  // Types
  type ImageBuildOptions,
  type ImageBuildContext,
} from './build-plugin';