Astral.Image.Config (Astral v0.2.1)

Configuration for Astral's build-time image pipeline.

Astral writes optimized image variants into the same browser asset output directory as Volt-managed JavaScript and CSS, while keeping image semantics in Astral. The cache directory stores generated variants between builds.

Summary

Types

t()

Functions

new(opts \\ [], site_config \\ nil)

Build normalized image configuration from site options.

Types

t()

@type t() :: %Astral.Image.Config{
  cache_dir: String.t(),
  concurrency: pos_integer(),
  default_format: atom(),
  fallback_format: atom(),
  formats: [atom()],
  quality: pos_integer(),
  remote_patterns: [Astral.Image.Remote.Pattern.t()],
  source_dirs: [String.t()],
  widths: [pos_integer()]
}

Functions

new(opts \\ [], site_config \\ nil)

@spec new(
  keyword(),
  Astral.Config.t() | nil
) :: t()

Build normalized image configuration from site options.