Repolode
Enviar
cloudflare

cloudflare/cloudflare-typescript

Biblioteca oficial de cliente TypeScript/JavaScript para a REST API da Cloudflare, gerada com Stainless.

Ver no GitHubSite
Estrelas
831
Forks
199
Issues abertas
20
Último commit
ontem

O que é?

Este é o cliente oficial para servidor, em TypeScript e JavaScript, da REST API da Cloudflare. Ele disponibiliza os recursos da API, como zonas, contas e namespaces KV, como métodos tipados com definições de parâmetros de requisição e campos de resposta, para que os desenvolvedores possam chamar os serviços da Cloudflare sem escrever requisições HTTP manualmente.

A biblioteca já cuida de questões comuns: novas tentativas automáticas com backoff exponencial para erros de conexão e respostas 408, 409, 429 e 5xx, timeouts configuráveis, classes de erro tipadas para cada status HTTP e paginação automática em endpoints de listagem com loops `for await`. O envio de arquivos aceita streams do Node, objetos `File` da Web, objetos `Response` do fetch ou um helper para bytes brutos.

Ela funciona em navegadores, Node.js 20+, Deno, Bun, Cloudflare Workers e Vercel Edge Runtime, e oferece um ponto de entrada compatível com tree-shaking para gerar bundles menores. A biblioteca é gerada com Stainless, e a lista completa de métodos está em api.md.

Recursos principais

  • 01Métodos tipados e definições de parâmetros para recursos da API da Cloudflare
  • 02Novas tentativas automáticas com backoff exponencial, configuráveis por meio de maxRetries
  • 03Classes de erro tipadas para cada código de status HTTP
  • 04Paginação automática em endpoints de listagem usando loops for await
  • 05Suporte ao envio de arquivos por streams do Node, objetos File e objetos Response
  • 06Cliente compatível com tree-shaking que inclui apenas os recursos selecionados

Casos de uso

  • Automatizar a criação e o gerenciamento de zonas DNS em um script de implantação Node.js
  • Gerenciar namespaces KV ou contas da Cloudflare a partir de um serviço de backend
  • Chamar as APIs da Cloudflare a partir de Cloudflare Workers ou funções Vercel Edge
  • Criar ferramentas internas que precisem de acesso tipado aos recursos da Cloudflare

Início rápido

  1. 1

    Instale a biblioteca do repositório via npm

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

    Crie um cliente usando o token de API do ambiente e chame a API

Antes de usar

  • Ainda não foi publicada no npm, então a instalação é feita atualmente por uma URL Git SSH.
  • É necessário um token de API da Cloudflare para fazer chamadas.

Tópicos

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

Perguntas frequentes

O que é cloudflare-typescript?
Biblioteca oficial de cliente TypeScript/JavaScript para a REST API da Cloudflare, gerada com Stainless. Este é o cliente oficial para servidor, em TypeScript e JavaScript, da REST API da Cloudflare. Ele disponibiliza os recursos da API, como zonas, contas e namespaces KV, como métodos tipados com definições de parâmetros de requisição e campos de resposta, para que os desenvolvedores possam chamar os serviços da Cloudflare sem escrever requisições HTTP manualmente.
cloudflare-typescript é gratuito? Qual é a licença?
cloudflare-typescript é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
cloudflare-typescript ainda é mantido?
Manutenção ativa. O último commit de cloudflare-typescript foi em 5 de nov. de 2026.
Para que posso usar cloudflare-typescript?
Automatizar a criação e o gerenciamento de zonas DNS em um script de implantação Node.js Gerenciar namespaces KV ou contas da Cloudflare a partir de um serviço de backend Chamar as APIs da Cloudflare a partir de Cloudflare Workers ou funções Vercel Edge Criar ferramentas internas que precisem de acesso tipado aos recursos da Cloudflare
Como instalar cloudflare-typescript?
Instale a biblioteca do repositório via npm: npm install git+ssh://git@github.com:cloudflare/cloudflare-typescript.git Crie um cliente usando o token de API do ambiente e chame a API
Onde consigo cloudflare-typescript?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/cloudflare/cloudflare-typescript

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados