Skip to content

Incorrect description of UnresolvedImageTransform in getImage() #13301

@decipher-cs

Description

@decipher-cs

📚 Subject area/topic

Image service, getImage

📋 Page(s) affected (or suggested, for new content)

https://docs.astro.build/en/reference/modules/astro-assets/#getimage

Image

📋 Description of content that is out-of-date or incorrect

According to the docs

This [getImage] takes an options object with the same properties as the Image component (except alt) and returns a GetImageResult object.

But hat's not the case. getImage() also doesn't accept layout property.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    improve or update documentationEnhance / update existing documentation (e.g. add example, improve description, update for changes)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions