Skip to content

Update Assets syntax to more standardised table #18919

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

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Update Assets syntax to more standardised table #18919

Show file tree
Hide file tree
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
22 changes: 13 additions & 9 deletions src/content/docs/workers/static-assets/binding.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@ compatibility_date = "2024-09-19"
main = "src/index.ts"
# The following configuration unconditionally invokes the Worker script at
# `src/index.ts`, which can programatically fetch assets via the ASSETS binding
assets = { directory = "./public/", binding = "ASSETS", experimental_serve_directly = false }
[assets]
directory = "./public/"
binding = "ASSETS"
experimental_serve_directly = false
```

</WranglerConfig>
Expand All @@ -88,7 +91,9 @@ name = "my-worker"
main = "./src/index.js"
compatibility_date = "2024-09-19"

assets = { directory = "./public/", binding = "ASSETS" }
[assets]
directory = "./public/"
binding = "ASSETS"
```

</WranglerConfig>
Expand All @@ -113,8 +118,8 @@ Your dynamic code can make new, or forward incoming, requests to your project's

Take the following example that configures a Worker script to return a response under all requests headed for `/api/`. Otherwise, the Worker script will pass the incoming request through to the asset binding. In this case, because a Worker script is only invoked when the requested route has not matched any static assets, this will always evaluate [`not_found_handling`](/workers/static-assets/routing/#routing-configuration) behavior.

<Tabs> <TabItem label="JavaScript" icon="seti:javascript">

<Tabs>
<TabItem label="JavaScript" icon="seti:javascript">
```js
export default {
async fetch(request, env) {
Expand All @@ -129,9 +134,8 @@ export default {
},
};
```

</TabItem> <TabItem label="TypeScript" icon="seti:typescript">

</TabItem>
<TabItem label="TypeScript" icon="seti:typescript">
```ts
interface Env {
ASSETS: Fetcher;
Expand All @@ -150,8 +154,8 @@ export default {
},
} satisfies ExportedHandler<Env>;
```

</TabItem> </Tabs>
</TabItem>
</Tabs>

## Routing configuration

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/workers/static-assets/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,17 @@ Requests to a project with static assets can either return static assets or invo

**Requests to static assets are free and unlimited**. Requests to the Worker script (e.g. in the case of SSR content) are billed according to Workers pricing. Refer to [pricing](/workers/platform/pricing/#example-2) for an example.

There's no additional cost for storing Assets.
There's no additional cost for storing Assets.

### Troubleshooting

- `assets.bucket is a required field` — if you see this error, you need to update Wrangler to at least `3.78.10` or later. `bucket` is not a required field.
- `assets.bucket is a required field` — if you see this error, you need to update Wrangler to at least `3.78.10` or later. `bucket` is not a required field.

### Limitations

The following limitations apply for Workers with static assets:

- There is a 20,000 file count limit per [Worker version](/workers/configuration/versions-and-deployments/), and a 25 MiB individual file size limit. This matches the [limits in Cloudflare Pages](/pages/platform/limits/) today.
- There is a 20,000 file count limit per [Worker version](/workers/configuration/versions-and-deployments/), and a 25 MiB individual file size limit. This matches the [limits in Cloudflare Pages](/pages/platform/limits/) today.
- You cannot upload static assets to [Workers for Platforms](/cloudflare-for-platforms/workers-for-platforms/) [user workers](/cloudflare-for-platforms/workers-for-platforms/reference/how-workers-for-platforms-works/). This is a temporary limitation, we are working to remove it.
- In local development, you cannot make [Service Binding RPC calls](/workers/runtime-apis/bindings/service-bindings/rpc/) to a Worker with static assets. This is a temporary limitation, we are working to remove it.
- Workers with assets cannot run on a [route or domain](/workers/configuration/routing/) with a path component. For example, `example.com/*` is an acceptable route, but `example.com/foo/*` is not. Wrangler and the Cloudflare dashboard will throw an error when you try and add a route with a path component.
Expand Down
Loading