Skip to content

Conversation

@emily-shen
Copy link
Contributor

@emily-shen emily-shen commented Feb 19, 2025

Summary

Once Wrangler v4 is out, we will be recommending people use the wrangler types command to generate runtime types instead of importing from @cloudflare/workers-types. This PR updates references to @cloudflare/workers-types to point to the wrangler types command instead.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

19 files reviewed, 2 total issue(s) found.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 19, 2025

Preview URL: https://0ef78e4d.preview.developers.cloudflare.com
Preview Branch URL: https://emily-type-gen.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/runtime-apis/rpc/typescript/ https://emily-type-gen.preview.developers.cloudflare.com/workers/runtime-apis/rpc/typescript/
https://developers.cloudflare.com/pages/framework-guides/nextjs/ssr/bindings/ https://emily-type-gen.preview.developers.cloudflare.com/pages/framework-guides/nextjs/ssr/bindings/
https://developers.cloudflare.com/workflows/build/workers-api/ https://emily-type-gen.preview.developers.cloudflare.com/workflows/build/workers-api/
https://developers.cloudflare.com/ai-gateway/integrations/worker-binding-methods/ https://emily-type-gen.preview.developers.cloudflare.com/ai-gateway/integrations/worker-binding-methods/
https://developers.cloudflare.com/pages/framework-guides/deploy-a-nuxt-site/ https://emily-type-gen.preview.developers.cloudflare.com/pages/framework-guides/deploy-a-nuxt-site/
https://developers.cloudflare.com/pub-sub/learning/integrate-workers/ https://emily-type-gen.preview.developers.cloudflare.com/pub-sub/learning/integrate-workers/
https://developers.cloudflare.com/workflows/examples/send-invoices/ https://emily-type-gen.preview.developers.cloudflare.com/workflows/examples/send-invoices/
https://developers.cloudflare.com/pages/framework-guides/deploy-an-astro-site/ https://emily-type-gen.preview.developers.cloudflare.com/pages/framework-guides/deploy-an-astro-site/
https://developers.cloudflare.com/vectorize/reference/client-api/ https://emily-type-gen.preview.developers.cloudflare.com/vectorize/reference/client-api/
https://developers.cloudflare.com/d1/worker-api/ https://emily-type-gen.preview.developers.cloudflare.com/d1/worker-api/
https://developers.cloudflare.com/pages/framework-guides/deploy-a-qwik-site/ https://emily-type-gen.preview.developers.cloudflare.com/pages/framework-guides/deploy-a-qwik-site/
https://developers.cloudflare.com/workers/runtime-apis/request/ https://emily-type-gen.preview.developers.cloudflare.com/workers/runtime-apis/request/
https://developers.cloudflare.com/workers/testing/vitest-integration/migration-guides/migrate-from-miniflare-2/ https://emily-type-gen.preview.developers.cloudflare.com/workers/testing/vitest-integration/migration-guides/migrate-from-miniflare-2/
https://developers.cloudflare.com/workflows/examples/backup-d1/ https://emily-type-gen.preview.developers.cloudflare.com/workflows/examples/backup-d1/

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 13, 2025

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 Summary

Updated documentation to recommend using the wrangler types command for generating runtime types instead of importing from @cloudflare/workers-types.

  • Revised instructions for setting up Workers and Pages projects with TypeScript.
  • Updated references from @cloudflare/workers-types to wrangler types command.
  • Removed prerequisites for installing @cloudflare/workers-types in several guides.

Modified Files

  • src/content/docs/agents/index.mdx
  • src/content/docs/ai-gateway/integrations/worker-binding-methods.mdx
  • src/content/docs/d1/worker-api/index.mdx
  • src/content/docs/pages/framework-guides/deploy-a-nuxt-site.mdx
  • src/content/docs/pages/framework-guides/deploy-a-qwik-site.mdx
  • src/content/docs/pages/framework-guides/deploy-an-astro-site.mdx
  • src/content/docs/pages/framework-guides/nextjs/ssr/bindings.mdx
  • src/content/docs/vectorize/reference/client-api.mdx
  • src/content/docs/workers/runtime-apis/request.mdx
  • src/content/docs/workers/runtime-apis/rpc/typescript.mdx
  • src/content/docs/workflows/build/workers-api.mdx
  • src/content/docs/workflows/examples/backup-d1.mdx
  • src/content/docs/workflows/examples/send-invoices.mdx

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 hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

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 hyperlint-ignore to the PR to ignore the link check for this PR.

@emily-shen emily-shen requested review from a team and danielgek as code owners April 14, 2025 05:38
@emily-shen emily-shen requested a review from a team as a code owner May 7, 2025 17:06
@github-actions github-actions bot added size/l and removed size/m labels May 7, 2025
@emily-shen emily-shen force-pushed the emily/type-gen branch 2 times, most recently from a0e1fba to f40ebff Compare May 8, 2025 11:32
@emily-shen emily-shen requested a review from dcpena as a code owner May 8, 2025 11:32
@github-actions github-actions bot added the product:pub-sub Pub/Sub: https://developers.cloudflare.com/pub-sub label May 8, 2025
@github-actions github-actions bot added size/m and removed product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/l labels May 8, 2025
@emily-shen emily-shen enabled auto-merge (squash) May 13, 2025 16:09
@github-actions
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/ai-gateway/ @kathayl, @mchenco, @daisyfaithauma, @cloudflare/pcx-technical-writing
/src/content/docs/d1/ @elithrar, @rozenmd, @vy-ton, @joshthoward, @oxyjun, @harshil1712, @cloudflare/pcx-technical-writing
/src/content/docs/pages/framework-guides/ @igorminar, @cloudflare/wrangler, @aninibread, @GregBrimble, @ToriLindsay, @cloudflare/pcx-technical-writing
/src/content/docs/pub-sub/ @elithrar, @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/vectorize/ @elithrar, @vy-ton, @sejoker, @mchenco, @cloudflare/pcx-technical-writing
/src/content/docs/workers/runtime-apis/ @irvinebroque, @jasnell, @mikenomitch, @GregBrimble, @ToriLindsay, @cloudflare/pcx-technical-writing
/src/content/docs/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @WalshyDev, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing, @ToriLindsay, @cloudflare/wrangler
/src/content/docs/workflows/ @elithrar, @celso, @cloudflare/pcx-technical-writing
/src/content/partials/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @WalshyDev, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing, @ToriLindsay, @cloudflare/wrangler

@emily-shen emily-shen merged commit 60d7fa9 into production May 13, 2025
12 checks passed
@emily-shen emily-shen deleted the emily/type-gen branch May 13, 2025 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocked product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ product:d1 D1: https://developers.cloudflare.com/d1/ product:pages product:pub-sub Pub/Sub: https://developers.cloudflare.com/pub-sub product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ product:workers Related to Workers product product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.