update references to @cloudflare/workers-types

emily-shen · emily-shen · commit a34c9cb56f99 · 2025-02-19T12:03:35.000Z
diff --git a/src/content/docs/agents/index.mdx b/src/content/docs/agents/index.mdx
@@ -351,7 +351,6 @@ import {
   CloudflareVectorizeStore,
   CloudflareWorkersAIEmbeddings
 } from "@langchain/cloudflare";
-import { VectorizeIndex } from "@cloudflare/workers-types";
 import { Ai } from "@cloudflare/ai";
 import { Hono } from "hono";
 
@@ -419,7 +418,7 @@ export default app;
 </TabItem>
 <TabItem label="AI SDK">
 
-Ship faster with the [AI SDK](https://sdk.vercel.ai/docs/introduction): make it easier to generate text, tool call and/or get structured output from your AI models (and then deploy it [Workers](/workers/).
+Ship faster with the [AI SDK](https://sdk.vercel.ai/docs/introduction): make it easier to generate text, tool call and/or get structured output from your AI models (and then deploy it [Workers](/workers/)).
 
 ```sh
 npm i ai workers-ai-provider
diff --git a/src/content/docs/ai-gateway/integrations/worker-binding-methods.mdx b/src/content/docs/ai-gateway/integrations/worker-binding-methods.mdx
@@ -8,10 +8,6 @@ import { Render, PackageManagers } from "~/components";
 
 This guide provides an overview of how to use the latest Cloudflare Workers AI Gateway binding methods. You will learn how to set up an AI Gateway binding, access new methods, and integrate them into your Workers.
 
-## Prerequisites
-
-- Install and use the `@cloudflare/workers-types` library, version `4.20250124.3` or above.
-
 ## 1. Add an AI Binding to your Worker
 
 To connect your Worker to Workers AI, add the following to your [Wrangler configuration file](/workers/wrangler/configuration/):
@@ -37,7 +33,7 @@ To perform an inference task using Workers AI and an AI Gateway, you can use the
 const resp = await env.AI.run("@cf/meta/llama-3.1-8b-instruct", {
   prompt: "tell me a joke"
 }, {
-  gateway: {
+		gateway: {
     id: "my-gateway"
   }
 });
@@ -65,9 +61,9 @@ The `patchLog` method allows you to send feedback, score, and metadata for a spe
 
 ```typescript
 gateway.patchLog('my-log-id', {
-  feedback: 1,
-  score: 100,
-  metadata: {
+	feedback: 1,
+	score: 100,
+	metadata: {
     user: "123"
   }
 });
@@ -78,7 +74,7 @@ gateway.patchLog('my-log-id', {
 
 ### 3.2. `getLog`: Read Log Details
 
-The `getLog` method retrieves details of a specific log ID. It returns an object of type `Promise<AiGatewayLog>`. You can import the `AiGatewayLog` type from the `@cloudflare/workers-types` library.
+The `getLog` method retrieves details of a specific log ID. It returns an object of type `Promise<AiGatewayLog>`. If this type is missing, ensure you have run [`wrangler types`](/workers/languages/typescript/#generate-types)
 
 ```typescript
 const log = await gateway.getLog("my-log-id");
@@ -95,12 +91,12 @@ Refer to the [Universal endpoint documentation](/ai-gateway/providers/universal/
 
 ```typescript
 const resp = await gateway.run({
-  provider: "workers-ai",
-  endpoint: "@cf/meta/llama-3.1-8b-instruct",
-  headers: {
+	provider: "workers-ai",
+	endpoint: "@cf/meta/llama-3.1-8b-instruct",
+	headers: {
     authorization: "Bearer my-api-token"
-  },
-  query: {
+	},
+	query: {
     prompt: "tell me a joke"
   }
 });
@@ -118,4 +114,3 @@ With the new AI Gateway binding methods, you can now:
 - Execute universal requests to any AI Gateway provider with `run`.
 
 These methods offer greater flexibility and control over your AI integrations, empowering you to build more sophisticated applications on the Cloudflare Workers platform.
-
diff --git a/src/content/docs/d1/worker-api/index.mdx b/src/content/docs/d1/worker-api/index.mdx
@@ -18,7 +18,7 @@ Refer to the relevant sections for the API documentation.
 
 ## TypeScript support
 
-D1 Worker Bindings API is fully-typed via the [`@cloudflare/workers-types`](/workers/languages/typescript/#typescript) package, and also supports [generic types](https://www.typescriptlang.org/docs/handbook/2/generics.html#generic-types) as part of its TypeScript API. A generic type allows you to provide an optional `type parameter` so that a function understands the type of the data it is handling.
+D1 Worker Bindings API is fully-typed via the types generated by running [`wrangler types`](/workers/languages/typescript/#typescript) package, and also supports [generic types](https://www.typescriptlang.org/docs/handbook/2/generics.html#generic-types) as part of its TypeScript API. A generic type allows you to provide an optional `type parameter` so that a function understands the type of the data it is handling.
 
 When using the query statement methods [`D1PreparedStatement::run`](/d1/worker-api/prepared-statements/#run), [`D1PreparedStatement::raw`](/d1/worker-api/prepared-statements/#raw) and [`D1PreparedStatement::first`](/d1/worker-api/prepared-statements/#first), you can provide a type representing each database row. D1's API will [return the result object](/d1/worker-api/return-object/#d1result) with the correct type.
 
diff --git a/src/content/docs/pages/framework-guides/deploy-a-nuxt-site.mdx b/src/content/docs/pages/framework-guides/deploy-a-nuxt-site.mdx
@@ -121,17 +121,11 @@ In order to access bindings in a deployed application, you will need to [configu
 
 ### Add bindings to TypeScript projects
 
-To get proper type support, you need to create a new `env.d.ts` file in the root of your project and declare a [binding](/pages/functions/bindings/).
+To get proper type support, you need to create a new `env.d.ts` file in the root of your project and declare a [binding](/pages/functions/bindings/). Make sure you have generated Cloudflare runtime types by running [`wrangler types`](/pages/functions/typescript/).
 
 The following is an example of adding a `KVNamespace` binding:
 
 ```ts null {9}
-import {
-	CfProperties,
-	Request,
-	ExecutionContext,
-	KVNamespace,
-} from "@cloudflare/workers-types";
 
 declare module "h3" {
 	interface H3EventContext {
diff --git a/src/content/docs/pages/framework-guides/deploy-a-qwik-site.mdx b/src/content/docs/pages/framework-guides/deploy-a-qwik-site.mdx
@@ -70,7 +70,7 @@ The following code block shows an example of accessing a KV namespace in QwikCit
 // ...
 
 export const useGetServerTime = routeLoader$(({ platform }) => {
-  // the type `KVNamespace` comes from the @cloudflare/workers-types package
+  // the type `KVNamespace` comes from types generated by running `wrangler types`
   const { MY_KV } = (platform.env as { MY_KV: KVNamespace }));
 
   return {
diff --git a/src/content/docs/pages/framework-guides/deploy-an-astro-site.mdx b/src/content/docs/pages/framework-guides/deploy-an-astro-site.mdx
@@ -109,12 +109,11 @@ Use bindings in Astro components and API routes by using `context.locals` from [
 
 Refer to the following example of how to access a KV namespace with TypeScript.
 
-First, you need to define Cloudflare runtime and KV type by updating the `env.d.ts`:
+First, you need to define Cloudflare runtime and KV type by updating the `env.d.ts`. Make sure you have generated Cloudflare runtime types by running [`wrangler types`](/pages/functions/typescript/). 
 
 ```typescript
 /// <reference types="astro/client" />
 
-type KVNamespace = import("@cloudflare/workers-types").KVNamespace;
 type ENV = {
 	// replace `MY_KV` with your KV namespace
 	MY_KV: KVNamespace;
@@ -133,7 +132,6 @@ You can then access your KV from an API endpoint in the following way:
 import type { APIContext } from "astro";
 
 export async function get({ locals }: APIContext) {
-	// the type KVNamespace comes from the @cloudflare/workers-types package
 	const { MY_KV } = locals.runtime.env;
 
 	return {
diff --git a/src/content/docs/pages/framework-guides/nextjs/ssr/bindings.mdx b/src/content/docs/pages/framework-guides/nextjs/ssr/bindings.mdx
@@ -30,32 +30,7 @@ Add bindings to your Pages project by adding them to your [Wrangler configuratio
 
 ## TypeScript type declarations for bindings
 
-To ensure that the `env` object from `getRequestContext().env` above has accurate TypeScript types, install [`@cloudflare/workers-types`](https://www.npmjs.com/package/@cloudflare/workers-types) and create a [TypeScript declaration file](https://www.typescriptlang.org/docs/handbook/2/type-declarations.html).
-
-Install Workers Types:
-
-```sh
-npm install --save-dev @cloudflare/workers-types
-```
-
-Add Workers Types to your `tsconfig.json` file, replacing the date below with your project's [compatibility date](/workers/configuration/compatibility-dates/):
-
-```diff title="tsconfig.json"
-    "types": [
-+        "@cloudflare/workers-types/2024-07-29"
-    ]
-```
-
-Create an `env.d.ts` file in the root directory of your Next.js app, and explicitly declare the type of each binding:
-
-```ts title="env.d.ts"
-interface CloudflareEnv {
-	MY_KV_1: KVNamespace;
-	MY_KV_2: KVNamespace;
-	MY_R2: R2Bucket;
-	MY_DO: DurableObjectNamespace;
-}
-```
+To ensure that the `env` object from `getRequestContext().env` above has accurate TypeScript types, make sure you have generated types by running [`wrangler types`](/workers/languages/typescript/#generate-types) and followed the setup steps.
 
 ## Other Cloudflare APIs (`cf`, `ctx`)
 
diff --git a/src/content/docs/vectorize/reference/client-api.mdx b/src/content/docs/vectorize/reference/client-api.mdx
@@ -220,4 +220,4 @@ Refer to the [bindings documentation](/workers/wrangler/configuration/#vectorize
 
 New Workers projects created via `npm create cloudflare@latest` automatically include the relevant TypeScript types for Vectorize.
 
-Older projects, or non-Workers projects looking to use Vectorize's [REST API](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/list/) in a TypeScript project, should ensure `@cloudflare/workers-types` version `4.20230922.0` or later is installed.
+If you have an older project, or a non-Workers projects looking to use Vectorize's [REST API](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/list/) in a TypeScript project, you should ensure you have a compatibility date later than `2023-09-22` and that you have generated types by running [`wrangler types`](/workers/languages/typescript/#generate-types).  
diff --git a/src/content/docs/workers/runtime-apis/request.mdx b/src/content/docs/workers/runtime-apis/request.mdx
@@ -99,7 +99,7 @@ An object containing Cloudflare-specific properties that can be set on the `Requ
 fetch(event.request, { cf: { scrapeShield: false } })
 ```
 
-Invalid or incorrectly-named keys in the `cf` object will be silently ignored. Consider using TypeScript and [`@cloudflare/workers-types`](https://www.npmjs.com/package/@cloudflare/workers-types) to ensure proper use of the `cf` object.
+Invalid or incorrectly-named keys in the `cf` object will be silently ignored. Consider using TypeScript and generating types by running [`wrangler types`](/workers/languages/typescript/#generate-types) to ensure proper use of the `cf` object.
 
 
 
diff --git a/src/content/docs/workers/runtime-apis/rpc/typescript.mdx b/src/content/docs/workers/runtime-apis/rpc/typescript.mdx
@@ -11,7 +11,7 @@ description: How TypeScript types for your Worker or Durable Object's RPC
 
 ---
 
-The [`@cloudflare/workers-types`](https://www.npmjs.com/package/@cloudflare/workers-types) package provides the `Service` and `DurableObjectNamespace` types, each of which accepts a single type parameter for the server-side [`WorkerEntrypoint`](/workers/runtime-apis/bindings/service-bindings/rpc) or [`DurableObject`](/durable-objects/best-practices/create-durable-object-stubs-and-send-requests/#call-rpc-methods) types.
+The types generated by running [`wrangler types`](/workers/languages/typescript/#generate-types) provide the `Service` and `DurableObjectNamespace` types, each of which accepts a single type parameter for the server-side [`WorkerEntrypoint`](/workers/runtime-apis/bindings/service-bindings/rpc) or [`DurableObject`](/durable-objects/best-practices/create-durable-object-stubs-and-send-requests/#call-rpc-methods) types.
 
 Using higher-order types, we automatically generate client-side stub types (e.g., forcing all methods to be async).
 
diff --git a/src/content/docs/workers/testing/vitest-integration/get-started/write-your-first-test.mdx b/src/content/docs/workers/testing/vitest-integration/get-started/write-your-first-test.mdx
@@ -92,15 +92,16 @@ For a full list of available Miniflare options, refer to the [Miniflare `Workers
 
 ## Define types
 
-If you are using TypeScript, you will need to define types for Cloudflare Workers and `cloudflare:test` to make sure they are detected appropriately. Add a `tsconfig.json` in the same folder as your tests (that is, `test`) and add the following:
+If you are using TypeScript, you will need to define types for Cloudflare Workers and `cloudflare:test` to make sure they are detected appropriately. Make sure you have generated Worker types by running [`wrangler types`](/workers/languages/typescript/#generate-types). Then add a `tsconfig.json` in the same folder as your tests (that is, `test`) and add the following:
 
 ```js
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "moduleResolution": "bundler",
     "types": [
-      "@cloudflare/workers-types/experimental",
+      // use the path to .d.ts file generated by running wrangler types
+			"../worker-configuration.d.ts",
       "@cloudflare/vitest-pool-workers"
     ]
   },
diff --git a/src/content/docs/workflows/build/workers-api.mdx b/src/content/docs/workflows/build/workers-api.mdx
@@ -191,7 +191,7 @@ script_name = "billing-worker"
 
 :::note
 
-Ensure you have `@cloudflare/workers-types` version `4.20241022.0` or later installed when binding to Workflows from within a Workers project.
+Ensure you have a compatibility date `2024-10-22` or later installed when binding to Workflows from within a Workers project. If you are using Typescript, ensure you have generated types by running [`wrangler types`](/workers/languages/typescript/#generate-types).
 
 :::
 
diff --git a/src/content/docs/workflows/examples/backup-d1.mdx b/src/content/docs/workflows/examples/backup-d1.mdx
@@ -114,7 +114,6 @@ Here is a minimal package.json:
 ```json
 {
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20241224.0",
     "wrangler": "^3.99.0"
   }
 }
@@ -143,4 +142,6 @@ bucket_name = "d1-backups"
 crons = [ "0 0 * * *" ]
 ```
 
-</WranglerConfig>
+</WranglerConfig>
+
+Also ensure you have generated types by running [`wrangler types`](/workers/languages/typescript/#generate-types).
diff --git a/src/content/docs/workflows/examples/send-invoices.mdx b/src/content/docs/workflows/examples/send-invoices.mdx
@@ -192,7 +192,6 @@ Here's a minimal package.json:
 ```json
 {
     "devDependencies": {
-        "@cloudflare/workers-types": "^4.20241022.0",
         "wrangler": "^3.83.0"
     },
     "dependencies": {
@@ -220,4 +219,6 @@ class_name = "cartInvoicesWorkflow"
 name = "SEND_EMAIL"
 ```
 
-</WranglerConfig>
+</WranglerConfig>
+
+Also ensure you have generated types by running [`wrangler types`](/workers/languages/typescript/#generate-types).

Original file line number	Diff line number	Diff line change
`@@ -220,4 +220,4 @@ Refer to the [bindings documentation](/workers/wrangler/configuration/#vectorize`
`220`	`220`
`221`	`221`	New Workers projects created via `npm create cloudflare@latest` automatically include the relevant TypeScript types for Vectorize.
`222`	`222`
`223`		-Older projects, or non-Workers projects looking to use Vectorize's [REST API](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/list/) in a TypeScript project, should ensure `@cloudflare/workers-types` version `4.20230922.0` or later is installed.
	`223`	+If you have an older project, or a non-Workers projects looking to use Vectorize's [REST API](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/list/) in a TypeScript project, you should ensure you have a compatibility date later than `2023-09-22` and that you have generated types by running [`wrangler types`](/workers/languages/typescript/#generate-types).