Repolode
Enviar
cloudflare

cloudflare/cloudflare-typescript

Cliente oficial de TypeScript/JavaScript para la API REST de Cloudflare, generado con Stainless.

Ver en GitHubSitio web
Estrellas
831
Forks
199
Issues abiertos
20
Último commit
anteayer

¿Qué es?

Este es el cliente oficial de TypeScript y JavaScript del lado del servidor para la API REST de Cloudflare. Expone los recursos de la API, como zonas, cuentas y espacios de nombres de KV, mediante métodos tipados con definiciones de parámetros de solicitud y campos de respuesta, para que los desarrolladores puedan llamar a los servicios de Cloudflare sin escribir solicitudes HTTP a mano.

La biblioteca gestiona de forma integrada aspectos habituales: reintentos automáticos con retroceso exponencial ante errores de conexión y respuestas 408, 409, 429 y 5xx; tiempos de espera configurables; clases de error tipadas para cada estado HTTP; y paginación automática en los endpoints de listas mediante bucles `for await`. Para las cargas de archivos, acepta streams de Node, objetos web `File`, respuestas de `fetch` o un helper para bytes sin procesar.

Funciona en navegadores, Node.js 20+, Deno, Bun, Cloudflare Workers y Vercel Edge Runtime, y ofrece un punto de entrada compatible con tree-shaking para generar bundles más pequeños. La biblioteca se genera con Stainless; la lista completa de métodos está en api.md.

Funciones clave

  • 01Métodos tipados y definiciones de parámetros para los recursos de la API de Cloudflare
  • 02Reintentos automáticos con retroceso exponencial, configurables mediante maxRetries
  • 03Clases de error tipadas para cada código de estado HTTP
  • 04Paginación automática en endpoints de listas mediante bucles for await
  • 05Compatibilidad con cargas de archivos desde streams de Node, objetos File y Responses
  • 06Cliente compatible con tree-shaking que incluye solo los recursos seleccionados

Casos de uso

  • Automatizar la creación y gestión de zonas DNS desde un script de despliegue de Node.js
  • Gestionar espacios de nombres de Cloudflare KV o cuentas desde un servicio backend
  • Llamar a las API de Cloudflare desde Cloudflare Workers o funciones de Vercel Edge
  • Crear herramientas internas que necesiten acceso tipado a los recursos de Cloudflare

Inicio rápido

  1. 1

    Instala la biblioteca desde el repositorio mediante npm

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

    Crea un cliente con el token de API del entorno y llama a la API

Antes de usarlo

  • Todavía no está publicada en npm, por lo que actualmente se instala mediante una URL Git SSH.
  • Se necesita un token de API de Cloudflare para realizar llamadas.

Temas

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

Preguntas frecuentes

¿Qué es cloudflare-typescript?
Cliente oficial de TypeScript/JavaScript para la API REST de Cloudflare, generado con Stainless. Este es el cliente oficial de TypeScript y JavaScript del lado del servidor para la API REST de Cloudflare. Expone los recursos de la API, como zonas, cuentas y espacios de nombres de KV, mediante métodos tipados con definiciones de parámetros de solicitud y campos de respuesta, para que los desarrolladores puedan llamar a los servicios de Cloudflare sin escribir solicitudes HTTP a mano.
¿cloudflare-typescript es gratuito? ¿Qué licencia tiene?
cloudflare-typescript es open source bajo la licencia Apache-2.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿cloudflare-typescript sigue mantenido?
Mantenimiento activo. El último commit de cloudflare-typescript fue el 5 nov 2026.
¿Para qué puedo usar cloudflare-typescript?
Automatizar la creación y gestión de zonas DNS desde un script de despliegue de Node.js Gestionar espacios de nombres de Cloudflare KV o cuentas desde un servicio backend Llamar a las API de Cloudflare desde Cloudflare Workers o funciones de Vercel Edge Crear herramientas internas que necesiten acceso tipado a los recursos de Cloudflare
¿Cómo se instala cloudflare-typescript?
Instala la biblioteca desde el repositorio mediante npm: npm install git+ssh://git@github.com:cloudflare/cloudflare-typescript.git Crea un cliente con el token de API del entorno y llama a la API
¿Dónde consigo cloudflare-typescript?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/cloudflare/cloudflare-typescript

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados