Repolode
提交项目
cloudflare

cloudflare/cloudflare-typescript

Cloudflare REST API 的官方 TypeScript/JavaScript 客户端库，服务端调用。

在 GitHub 查看官网
Star
831
Fork
199
未关闭 Issue
20
最近提交
前天

这是什么？

这是 Cloudflare REST API 的官方服务端 TypeScript/JavaScript 客户端。它把 zones、accounts、KV 命名空间等资源封装为带类型定义的方法，开发者无需手写 HTTP 请求即可调用 Cloudflare 服务。

库内置了常用能力：连接错误以及 408、409、429、5xx 响应会按指数退避自动重试，超时时间可配置，每种 HTTP 状态码对应独立的错误类，列表接口可通过 `for await` 自动翻页。文件上传支持 Node 流、Web File 对象、fetch Response 以及用于原始字节的辅助函数。

它可运行于浏览器、Node.js 20 及以上、Deno、Bun、Cloudflare Workers 和 Vercel Edge Runtime，并提供支持 tree shaking 的入口以减小打包体积。该库由 Stainless 生成，完整方法列表见 api.md。

核心功能

  • 01为 Cloudflare API 资源提供带类型的方法和参数定义
  • 02支持指数退避自动重试，可通过 maxRetries 配置
  • 03每种 HTTP 状态码对应独立的错误类型
  • 04列表接口可通过 for await 自动翻页
  • 05支持 Node 流、File 对象和 Response 作为文件上传内容
  • 06支持按需引入资源的 tree-shakable 客户端

适用场景

  • 在 Node.js 部署脚本中自动创建和管理 DNS zone
  • 在后端服务中管理 Cloudflare KV 命名空间或账户
  • 在 Cloudflare Workers 或 Vercel Edge 函数中调用 Cloudflare API
  • 构建需要类型化访问 Cloudflare 资源的内部工具

快速上手

  1. 1

    通过 npm 从仓库安装该库

    npm install git+ssh://git@github.com:cloudflare/cloudflare-typescript.git
  2. 2

    使用环境变量中的 API 令牌创建客户端并调用 API

使用前须知

  • 尚未发布到 npm，因此目前需要通过 Git SSH 地址安装。
  • 调用 API 需要 Cloudflare API 令牌。

标签

#api-client#cloudflare#sdk#typescript#dns#serverless#api#sdk-typescript

常见问题

cloudflare-typescript 是什么？
Cloudflare REST API 的官方 TypeScript/JavaScript 客户端库，服务端调用。 这是 Cloudflare REST API 的官方服务端 TypeScript/JavaScript 客户端。它把 zones、accounts、KV 命名空间等资源封装为带类型定义的方法，开发者无需手写 HTTP 请求即可调用 Cloudflare 服务。
cloudflare-typescript 可以免费使用吗？用的什么许可证？
cloudflare-typescript 以 Apache-2.0 许可证开源。用于商业产品前，请先确认许可证条款。
cloudflare-typescript 还在维护吗？
活跃维护中。cloudflare-typescript 最近一次提交是在 2026年11月5日。
cloudflare-typescript 适合用来做什么？
在 Node.js 部署脚本中自动创建和管理 DNS zone 在后端服务中管理 Cloudflare KV 命名空间或账户 在 Cloudflare Workers 或 Vercel Edge 函数中调用 Cloudflare API 构建需要类型化访问 Cloudflare 资源的内部工具
cloudflare-typescript 怎么安装和运行？
通过 npm 从仓库安装该库: npm install git+ssh://git@github.com:cloudflare/cloudflare-typescript.git 使用环境变量中的 API 令牌创建客户端并调用 API
在哪里获取 cloudflare-typescript？
源代码和安装说明在 GitHub 上：https://github.com/cloudflare/cloudflare-typescript

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目