Skip to content

docs(astro-assets): clarify getImage() options don't match all Image props #13786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nielskaspers wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(astro-assets): clarify getImage() options don't match all Image props #13786

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/content/docs/en/reference/modules/astro-assets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ If you need the resulting image URL client-side, you can [pass the `src` from a

The `getImage()` function is intended for generating images destined to be used somewhere else than directly in HTML, for example in an [API Route](/en/guides/endpoints/#server-endpoints-api-routes). It also allows you to create your own custom `<Image />` component.

This takes an options object with the [same properties as the Image component](#image-) (except `alt`) and returns a [`GetImageResult` object](#getimageresult).
This takes an options object with a subset of the [Image component properties](#image-) (excluding `alt`, `priority`, and `layout`) and returns a [`GetImageResult` object](#getimageresult).

The following example generates an AVIF `background-image` for a `<div />`:

Expand Down Expand Up @@ -828,7 +828,7 @@ See [`getConfiguredImageService()`](#getconfiguredimageservice) from `astro:asse
**Type:** <code>(options: <a href="#unresolvedimagetransform">UnresolvedImageTransform</a>, imageConfig: <a href="/en/reference/configuration-reference/#image-options">AstroConfig['image']</a>) => Promise\<<a href="#getimageresult">GetImageResult</a>\></code>
</p>

A function similar to [`getImage()`](#getimage) from `astro:assets` with two required arguments: an `options` object with [the same properties as the Image component](#image-) and a second object for the [image configuration](/en/reference/configuration-reference/#image-options).
A function similar to [`getImage()`](#getimage) from `astro:assets` with two required arguments: an `options` object with a subset of the [Image component properties](#image-) (excluding `alt`, `priority`, and `layout`), and a second object for the [image configuration](/en/reference/configuration-reference/#image-options).

### `isLocalService()`

Expand Down
Loading