@fedify/cfworkers

中文文档
2.1.32发布于 2026/11/17MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 9469

Adapt Fedify with Cloudflare Workers

原始使用文档
文档目录3 节
  1. WorkersKvStore
  2. WorkersMessageQueue
  3. Installation

@fedify/cfworkers: Adapt Fedify with Cloudflare Workers

JSR npm Follow @fedify@hollo.social

This package is available since Fedify 1.9.0.

This package provides Fedify's KvStore and MessageQueue implementations for Cloudflare Workers:

import { createFederation, type Message } from "@fedify/fedify";
import { WorkersKvStore, WorkersMessageQueue } from "@fedify/cfworkers";

type Env = {
  KV_BINDING: KVNamespace<string>;
  QUEUE_BINDING: Queue;
};

export default {
  async fetch(request: Request, env: Env): Promise<Response> {
    const federation = createFederation<Env>({
      kv: new WorkersKvStore(env.KV_BINDING),
      queue: new WorkersMessageQueue(env.QUEUE_BINDING),
      // Cloudflare Queues cannot be polled, so the queue() handler below
      // consumes the messages instead of Federation.startQueue():
      manuallyStartQueue: true,
      // ... other options
    });

    return await federation.fetch(request, { contextData: env });
  },

  async queue(batch: MessageBatch<unknown>, env: Env): Promise<void> {
    const federation = createFederation<Env>({
      kv: new WorkersKvStore(env.KV_BINDING),
      queue: new WorkersMessageQueue(env.QUEUE_BINDING),
      // Inbox listeners run inside processQueuedTask() and may call
      // ctx.sendActivity(), which would otherwise start the queue workers
      // automatically:
      manuallyStartQueue: true,
      // ... other options
    });

    for (const message of batch.messages) {
      await federation.processQueuedTask(env, message.body as Message);
    }
  },
} satisfies ExportedHandler<Env>;

WorkersKvStore

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.

WorkersMessageQueue

WorkersMessageQueue is a message queue implementation for Cloudflare Workers that uses Cloudflare's built-in Cloudflare Queues API. It provides scalability and high performance, making it suitable for production use in Cloudflare Workers environments. It requires a Cloudflare Queues setup and management.

[!NOTE] Since your KVNamespace and Queue are not bound to global variables, but rather passed as arguments to the fetch() and queue() methods, you need to instantiate your Federation object inside these methods, rather than at the top level.

For better organization, you probably want to use a builder pattern to register your dispatchers and listeners before instantiating the Federation object.

[!NOTE] The Cloudflare Queues API does not provide a way to poll messages from the queue, so WorkersMessageQueue.listen() method always throws a TypeError when invoked. Instead, you should define a queue() method in your Cloudflare worker, which will be called by the Cloudflare Queues API when new messages are available in the queue. Inside the queue() method, you need to call Federation.processQueuedTask() method to manually process the messages. The queue() method is the only way to consume messages from the queue in Cloudflare Workers. Set manuallyStartQueue to true as well; otherwise Fedify tries to start the workers automatically, and since listen() throws, it logs a warning that they could not be started.

Installation

deno add jsr:@fedify/cfworkers  # Deno
npm  add     @fedify/cfworkers  # npm
pnpm add     @fedify/cfworkers  # pnpm
yarn add     @fedify/cfworkers  # Yarn
bun  add     @fedify/cfworkers  # Bun

版本与发布记录

@fedify/cfworkers 共发布 757 个版本,首次发布于 2025/08/26;过去 12 个月发布了 626 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.1.32latest2026/11/17今天
2.0.362026/11/17今天
2.3.16-dev.28452026/11/17今天
2.5.0-dev.28442026/11/17今天
2.0.36-dev.28432026/11/17今天
2.3.16-dev.28412026/11/17今天

其他发布通道:pr-405 → 1.9.0-pr.405.1518,pr-421 → 1.9.0-pr.421.1747,pr-474 → 2.0.0-pr.474.1879,pr-478 → 2.0.0-pr.478.1918,pr-479 → 2.0.0-pr.479.1922,pr-490 → 2.0.0-pr.490.2。

关于 @fedify/cfworkers 的常见问题

@fedify/cfworkers 是什么?

Adapt Fedify with Cloudflare Workers

如何安装 @fedify/cfworkers?

在项目目录运行 npm install @fedify/cfworkers,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@fedify/fedify(^2.1.32)、@cloudflare/workers-types(^4.20250906.0 || ^5.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fedify/cfworkers 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@fedify/cfworkers 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@fedify/cfworkers 可以商用吗?

@fedify/cfworkers 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fedify/cfworkers 的下载量有多少?

根据 npm 官方下载统计,@fedify/cfworkers 在 2026/10/15 – 2026/11/13 这 30 天内被下载 9,469 次,日均约 316 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fedify/cfworkers 还在维护吗?

最新版本 2.1.32 发布于 2026/11/17(今天);至今共发布 757 个版本,其中过去 12 个月发布了 626 个;首次发布于 2025/08/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。