Options

distCompress(options?: AstroDistCompressOptions)

`AstroDistCompressOptions`

Option	Type	Default	Description
`rules`	`CompressRule[]`	`defaultRules`	Ordered conversion rules. First match wins.
`fallback`	`FallbackConfig \| false`	`{ enabled: true, format: "webp" }`	Auto-adds a fallback output to every rule. See Fallback images.
`rewriteHtml`	`boolean`	`true`	Rewrite `<img>` into `<picture>` in the build output's HTML. See HTML rewriting.
`removeOriginal`	`boolean`	`false`	Delete original files once a fallback output exists. See Removing originals.
`extensions`	`string[]`	`["png", "jpg", "jpeg"]`	File extensions (without the dot) to scan for in the build output.
`exclude`	`string[]`	`[]`	Glob patterns, relative to the output root, to skip entirely.
`concurrency`	`number`	`4`	Number of images processed in parallel.
`logger`	`boolean`	`true`	Log progress and a bytes-saved summary via Astro's integration logger.
`dryRun`	`boolean`	`false`	Preview a run without touching the filesystem. See Dry run, errors & reporting.
`onError`	`"skip" \| "throw"`	`"skip"`	What to do when converting a single image fails. See Dry run, errors & reporting.
`report`	`string \| false`	`false`	Write a JSON summary of the run to this path. See Dry run, errors & reporting.

Field	Type	Description
`name`	`string?`	Label used only in logs.
`match`	`(ctx: ImageContext) => boolean`	Decides whether the rule applies to a given image.
`outputs`	`OutputTarget[]`	Formats to produce for matched images.
`removeOriginal`	`boolean?`	Overrides the global `removeOriginal` for this rule.

Field	Type	Description
`format`	`ImageFormat`	Target format: `"avif" \| "webp" \| "png" \| "jpeg" \| "jpg" \| "gif" \| "tiff"`.
`options`	`Record<string, unknown>?`	Passed straight through to sharp's `.toFormat(format, options)`.
`fallback`	`boolean?`	Marks this output as the one used for the final `<img src>`.
`sameFormatSuffix`	`string?`	Suffix used when the target format equals the source format, to avoid overwriting it. Default: `"-compressed"`.
`widths`	`number[]?`	Generate one width-resized variant per entry, wired up as a `srcset`. Widths larger than the source are dropped (no upscaling). See Responsive images.
`sizes`	`string?`	`sizes` attribute emitted on the corresponding `<source>`/`<img>` when `widths` produces more than one variant.

Field	Type	Default	Description
`enabled`	`boolean?`	`true`	Whether to auto-add the fallback format to every rule.
`format`	`ImageFormat?`	`"webp"`	Format to auto-add.
`options`	`Record<string, unknown>?`	`{ quality: 80 }`	Encode options for the auto-added output.

Passed to every rule's match function — see Rules for the full shape and field descriptions.