Skip to content

Document Cloudflare binding build-time image optimization #13848

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
Desel72 wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −2
Open

Document Cloudflare binding build-time image optimization #13848

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
17 changes: 15 additions & 2 deletions src/content/docs/en/guides/integrations-guide/cloudflare.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ It also accepts the following:
### `imageService`

<p>
**Type:** `'passthrough' | 'cloudflare' | 'cloudflare-binding' | 'compile' | 'custom' | { build: 'compile', runtime?: 'cloudflare-binding' | 'passthrough' }`<br />
**Type:** `'passthrough' | 'cloudflare' | 'cloudflare-binding' | 'compile' | 'custom' | { build: 'compile', runtime?: 'cloudflare-binding' | 'passthrough' } | { build: 'cloudflare-binding', runtime?: 'cloudflare-binding' | 'passthrough' }`<br />
**Default:** `'cloudflare-binding'`
</p>

Expand All @@ -128,7 +128,7 @@ Determines which image service is used by the adapter. The adapter will default
- **`compile`:** Uses a combination of internal dependencies to transform images locally at build time for prerendered routes. The noop `passthrough` option is configured for on-demand rendered pages.
- **`custom`:** Always uses the image service configured in [Image Options](/en/reference/configuration-reference/#image-options). **This option will not check to see whether the configured image service works in Cloudflare's `workerd` runtime.**

It is also possible to configure your image service as an object, setting both a build time and runtime service independently. Currently, `'compile'` is the only available build-time option. The supported runtime options are `'passthrough'` (default) and `'cloudflare-binding'`:
It is also possible to configure your image service as an object, setting both a build time and runtime service independently. The supported build-time options are `'compile'` and `'cloudflare-binding'`. The supported runtime options are `'passthrough'` (default) and `'cloudflare-binding'`:

```js title="astro.config.mjs" ins={6}
import { defineConfig } from 'astro/config';
Expand All @@ -141,6 +141,19 @@ export default defineConfig({
});
```

To opt in to build-time image optimization with the Cloudflare Images binding during `workerd` prerendering, set `build` to `'cloudflare-binding'`. The default string shorthand, `imageService: 'cloudflare-binding'`, keeps the existing runtime-only behavior.

```js title="astro.config.mjs" ins={6}
import { defineConfig } from 'astro/config';
import cloudflare from '@astrojs/cloudflare';

export default defineConfig({
adapter: cloudflare({
imageService: { build: 'cloudflare-binding', runtime: 'cloudflare-binding' }
}),
});
```

### `sessionKVBindingName`

<p>
Expand Down
Loading