Skip to content

オプション

ts
distCompress(options?: AstroDistCompressOptions)

AstroDistCompressOptions

オプションデフォルト説明
rulesCompressRule[]defaultRules変換ルールの並び。最初にマッチしたルールが使われる。
fallbackFallbackConfig | false{ enabled: true, format: "webp" }すべてのルールにフォールバック出力を自動追加。フォールバック画像を参照。
rewriteHtmlbooleantrueビルド出力のHTML内の<img><picture>へ書き換える。HTML書き換えを参照。
removeOriginalbooleanfalseフォールバック出力が存在する画像に限り、元ファイルを削除する。元ファイルの削除を参照。
extensionsstring[]["png", "jpg", "jpeg"]ビルド出力内でスキャン対象とする拡張子(ドットなし)。
excludestring[][]出力ルートからの相対パスで、完全に除外するglobパターン。
concurrencynumber4並列で処理する画像数。
loggerbooleantrueAstroのインテグレーションロガー経由で進捗と削減バイト数のサマリーを出力する。

CompressRule

フィールド説明
namestring?ログにのみ使われるラベル。
match(ctx: ImageContext) => booleanこのルールを画像に適用するかどうかを判定する。
outputsOutputTarget[]マッチした画像に対して生成するフォーマット群。
removeOriginalboolean?このルールに限り、グローバルなremoveOriginalを上書きする。

OutputTarget

フィールド説明
formatImageFormat変換先フォーマット: "avif" | "webp" | "png" | "jpeg" | "jpg" | "gif" | "tiff"
optionsRecord<string, unknown>?sharpの.toFormat(format, options)にそのまま渡される。
fallbackboolean?最終的な<img src>に使う出力としてマークする。
sameFormatSuffixstring?変換先フォーマットが元フォーマットと同じ場合に付与するサフィックス(上書き防止用)。デフォルト: "-compressed"

FallbackConfig

フィールドデフォルト説明
enabledboolean?trueすべてのルールにフォールバックフォーマットを自動追加するかどうか。
formatImageFormat?"webp"自動追加するフォーマット。
optionsRecord<string, unknown>?{ quality: 80 }自動追加される出力のエンコードオプション。

ImageContext

すべてのルールのmatch関数に渡されます。フィールドの全容はルールを参照してください。