cloudflare/cloudflare-typescript

これは何？

主な機能

• 01Cloudflare APIリソース向けの型付きメソッドとパラメーター定義
• 02maxRetriesで設定できる、指数バックオフ付きの自動リトライ
• 03HTTPステータスコードごとの型付きエラークラス
• 04for awaitループによるリストエンドポイントの自動ページネーション
• 05Nodeストリーム、Fileオブジェクト、Responseに対応したファイルアップロード
• 06選択したリソースだけを含められるtree-shakableなクライアント

ユースケース

• Node.jsのデプロイスクリプトからDNSゾーンの作成と管理を自動化する
• バックエンドサービスからCloudflare KV namespaceやアカウントを管理する
• Cloudflare WorkersやVercel Edge functionsからCloudflare APIを呼び出す
• Cloudflareリソースへの型付きアクセスが必要な社内ツールを構築する

クイックスタート

1. 1

   npm経由でリポジトリからライブラリをインストールします

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

   環境変数からAPIトークンを取得してクライアントを作成し、APIを呼び出します

使う前に知っておきたいこと

• !npmにはまだ公開されていないため、現在はGit SSH URL経由でインストールします。
• !呼び出しにはCloudflare APIトークンが必要です。

トピック

よくある質問

cloudflare-typescript とは？

Stainlessで生成された、Cloudflare REST API公式のTypeScript/JavaScriptクライアントライブラリ。 Cloudflare REST API公式のサーバーサイド向けTypeScript/JavaScriptクライアントです。ゾーン、アカウント、KV namespaceなどのAPIリソースを、リクエストパラメーターとレスポンスフィールドの定義を備えた型付きメソッドとして提供するため、HTTPリクエストを手書きせずにCloudflareのサービスを呼び出せます。

cloudflare-typescript は無料で使えますか？ライセンスは？

cloudflare-typescript は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

cloudflare-typescript は今もメンテナンスされていますか？

活発にメンテナンス中。cloudflare-typescript の最終コミットは 2026年11月5日 です。

cloudflare-typescript は何に使えますか？

Node.jsのデプロイスクリプトからDNSゾーンの作成と管理を自動化する バックエンドサービスからCloudflare KV namespaceやアカウントを管理する Cloudflare WorkersやVercel Edge functionsから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