clarify which bindings require module-worker syntax #21173
Conversation
Images bindings are hard to find from the main "images" landing page. Linking directly to them saves some confusion.
taylorlee
requested review from
a team,
GregBrimble,
ToriLindsay,
irvinebroque and
mikenomitch
as code owners
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
| 2. Your Worker will run faster. With service workers, bindings are exposed as globals. This means that for every request, the Workers runtime must create a new JavaScript execution context, which adds overhead and time. Workers written using ES modules can reuse the same execution context across multiple requests. | ||
| 3. You can [gradually deploy changes to your Worker](/workers/configuration/versions-and-deployments/gradual-deployments/) when you use the ES modules format. | ||
| 4. You can easily publish Workers using ES modules to `npm`, allowing you to import and reuse Workers within your codebase. | ||
| 1. Your Worker will run faster. With service workers, bindings are exposed as globals. This means that for every request, the Workers runtime must create a new JavaScript execution context, which adds overhead and time. Workers written using ES modules can reuse the same execution context across multiple requests. |
There was a problem hiding this comment.
Identified issues
- Vale Style Guide - (Terms-error) Use 'Workers' instead of 'workers'.
Proposed fix
| 1. Your Worker will run faster. With service workers, bindings are exposed as globals. This means that for every request, the Workers runtime must create a new JavaScript execution context, which adds overhead and time. Workers written using ES modules can reuse the same execution context across multiple requests. | |
| 1. Your Workers will run faster. With service workers, bindings are exposed as globals. This means that for every request, the Workers runtime must create a new JavaScript execution context, which adds overhead and time. Workers written using ES modules can reuse the same execution context across multiple requests. |
The term 'workers' should be capitalized to 'Workers' to comply with the style guide.
There was a problem hiding this comment.
This is a description about the effects to the singular Worker being migrated.
|
Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment. We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally. PR Change SummaryClarified bindings compatibility with module-worker syntax and improved navigation for image bindings.
Modified Files
How can I customize these reviews?Check out the Hyperlint AI Reviewer docs for more information on how to customize the review. If you just want to ignore it on this PR, you can add the Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add What is Hyperlint?Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation. |
* [Workers] Clarify which bindings are incompatible with ServiceWorkers * [Workers] deeplink to images bindings Images bindings are hard to find from the main "images" landing page. Linking directly to them saves some confusion.
7 participants
Summary
Images bindings are hard to find from the main "images" landing page.
Linking directly to them saves some confusion.
Screenshot
Documentation checklist