Repolode
cloudflare

cloudflare/cloudflare-typescript

Официальная клиентская библиотека TypeScript/JavaScript для Cloudflare REST API, сгенерированная с помощью Stainless.

Звёзды
831
Форки
199
Открытые issues
20
Последний коммит
позавчера

Что это?

Это официальная серверная клиентская библиотека TypeScript и JavaScript для Cloudflare REST API. Она предоставляет типизированные методы для ресурсов API, например зон, аккаунтов и пространств имён KV, с описанием параметров запросов и полей ответов. Благодаря этому разработчики могут обращаться к сервисам Cloudflare, не составляя HTTP-запросы вручную.

Библиотека из коробки берёт на себя типичные задачи: автоматически повторяет запросы с экспоненциальной задержкой при ошибках соединения и ответах 408, 409, 429 и 5xx, поддерживает настраиваемые таймауты, типизированные классы ошибок для каждого HTTP-статуса и автоматическую пагинацию списковых эндпоинтов с помощью циклов `for await`. Для загрузки файлов можно передавать потоки Node.js, объекты Web File, fetch Responses или использовать вспомогательную функцию для необработанных байтов.

Библиотека работает в браузерах, 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.js, объектов File и Responses
  • 06Клиент с поддержкой tree shaking, включающий только выбранные ресурсы

Сценарии использования

  • Автоматизация создания DNS-зон и управления ими с помощью скрипта развёртывания на Node.js
  • Управление пространствами имён KV или аккаунтами Cloudflare из backend-сервиса
  • Вызов Cloudflare API из Cloudflare Workers или функций Vercel Edge
  • Создание внутренних инструментов, которым нужен типизированный доступ к ресурсам Cloudflare

Быстрый старт

  1. 1

    Установите библиотеку из репозитория через npm

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

    Создайте клиент, используя API-токен из переменных окружения, и вызовите API

Что важно знать

  • Пакет ещё не опубликован в npm, поэтому сейчас установка выполняется через Git SSH URL.
  • Для вызовов требуется API-токен Cloudflare.

Темы

Частые вопросы

Что такое cloudflare-typescript?
Официальная клиентская библиотека TypeScript/JavaScript для Cloudflare REST API, сгенерированная с помощью Stainless. Это официальная серверная клиентская библиотека TypeScript и JavaScript для Cloudflare REST API. Она предоставляет типизированные методы для ресурсов API, например зон, аккаунтов и пространств имён KV, с описанием параметров запросов и полей ответов. Благодаря этому разработчики могут обращаться к сервисам Cloudflare, не составляя HTTP-запросы вручную.
cloudflare-typescript можно использовать бесплатно? Какая у него лицензия?
cloudflare-typescript распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
cloudflare-typescript всё ещё поддерживается?
Активно поддерживается. Последний коммит в cloudflare-typescript — 5 нояб. 2026 г..
Для чего можно использовать cloudflare-typescript?
Автоматизация создания DNS-зон и управления ими с помощью скрипта развёртывания на Node.js Управление пространствами имён KV или аккаунтами Cloudflare из backend-сервиса Вызов Cloudflare API из Cloudflare Workers или функций Vercel Edge Создание внутренних инструментов, которым нужен типизированный доступ к ресурсам 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

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

Лёгкая Go-утилита, которая автоматически определяет публичный IPv4/IPv6-адрес и обновляет DNS-записи у множества провайдеров.

17,5 тыс.+30 за неделю1,9 тыс.GoMITОбновлён 6 дней назад

Лёгкое приложение для самостоятельного размещения, которое периодически обновляет DNS-записи A/AAAA у множества провайдеров и предоставляет веб-интерфейс.

3,3 тыс.+11 за неделю287GoMITОбновлён 5 часов назад

Самостоятельно размещаемый инструмент, который автоматически настраивает маршруты Cloudflare Tunnel, DNS-записи и политики Access по меткам Docker-контейнеров.

2,5 тыс.+5 за неделю107PythonOtherАктивно поддерживаетсяОбновлён в прошлом месяце

Панель управления для собственного сервера: развёртывание веб-приложений, управление базами данных, Docker-контейнерами, DNS, резервными копиями и безопасностью на VPS или выделенном сервере.

1,8 тыс.+17 за неделю183PythonMITАктивно поддерживаетсяОбновлён 6 часов назад