Docs for WorkersKvStore

Author: dahlia

docs/.vitepress/config.mts

@@ -4,6 +4,7 @@ import deflist from "markdown-it-deflist";
 import footnote from "markdown-it-footnote";
 import { jsrRef } from "markdown-it-jsr-ref";
 import process from "node:process";
+import { ModuleKind, ModuleResolutionKind, ScriptTarget } from "typescript";
 import { defineConfig } from "vitepress";
 import {
   groupIconMdPlugin,
@@ -210,12 +211,16 @@ export default withMermaid(defineConfig({
       transformerTwoslash({
         twoslashOptions: {
           compilerOptions: {
+            moduleResolution: ModuleResolutionKind.Bundler,
+            module: ModuleKind.ESNext,
+            target: ScriptTarget.ESNext,
             lib: ["dom", "dom.iterable", "esnext"],
             types: [
               "dom",
               "dom.iterable",
               "esnext",
               "@teidesu/deno-types/full",
+              "@cloudflare/workers-types/experimental",
             ],
             // @ts-ignore: Although it's typed as string, it's actually an array
             jsx: ["react-jsx"],

docs/manual/kv.md

@@ -142,6 +142,55 @@ const federation = createFederation<void>({
 [`PostgresKvStore`]: https://jsr.io/@fedify/postgres/doc/kv/~/PostgresKvStore
 [@fedify/postgres]: https://github.com/fedify-dev/postgres
 
+### `WorkersKvStore` (Cloudflare Workers only)
+
+*This API is available since Fedify 1.6.0.*
+
+`WorkersKvStore` is a key–value store implementation for [Cloudflare Workers]
+that uses Cloudflare's built-in [Cloudflare Workers KV] API.  It provides
+persistent storage and good performance for Cloudflare Workers environments.
+It's suitable for production use in Cloudflare Workers applications.
+
+Best for
+:   Production use in Cloudflare Workers environments.
+
+Pros
+:   Persistent storage, good performance, easy to set up.
+
+Cons
+:   Only available in Cloudflare Workers runtime.
+
+~~~~ typescript twoslash
+// @noErrors: 2345
+import type { FederationBuilder } from "@fedify/fedify";
+const builder = undefined as unknown as FederationBuilder<void>;
+// ---cut-before---
+import type { Federation } from "@fedify/fedify";
+import { WorkersKvStore } from "@fedify/fedify/x/cfworkers";
+
+export default {
+  async fetch(request, env, ctx) {
+    const federation: Federation<void> = await builder.build({
+      kv: new WorkersKvStore(env.KV_BINDING),
+    });
+    return await federation.fetch(request, { contextData: undefined });
+  }
+} satisfies ExportedHandler<{ KV_BINDING: KVNamespace<string> }>;
+~~~~
+
+> [!NOTE]
+> Since your `KVNamespace` is not bound to a global variable, but rather
+> passed as an argument to the `fetch()` method, you need to instantiate
+> your `Federation` object inside the `fetch()` method.
+>
+> For better organization, you probably want to use a builder pattern to
+> register your dispatchers and listeners before instantiating the `Federation`
+> object.  See the [*Builder pattern for structuring*
+> section](./federation.md#builder-pattern-for-structuring) for details.
+
+[Cloudflare Workers]: https://workers.cloudflare.com/
+[Cloudflare Workers KV]: https://developers.cloudflare.com/kv/
+
 
 Implementing a custom `KvStore`
 -------------------------------

docs/package.json

@@ -1,9 +1,10 @@
 {
   "devDependencies": {
     "@braintree/sanitize-url": "^7.1.1",
+    "@cloudflare/workers-types": "4.20250529.0",
     "@deno/kv": "^0.8.4",
     "@fedify/amqp": "^0.2.0",
-    "@fedify/fedify": "^1.6.1-dev.828",
+    "@fedify/fedify": "1.6.1-pr.242.860",
     "@fedify/postgres": "^0.3.0",
     "@fedify/redis": "^0.4.0",
     "@hono/node-server": "^1.13.7",
@@ -30,6 +31,7 @@
     "mermaid": "^11.4.1",
     "postgres": "^3.4.5",
     "stringify-entities": "^4.0.4",
+    "typescript": "^5.8.3",
     "vitepress": "^1.5.0",
     "vitepress-plugin-group-icons": "^1.3.5",
     "vitepress-plugin-llms": "^1.1.0",