Repolode
cloudflare

cloudflare/cloudflare-typescript

Stainless로 생성된 Cloudflare REST API용 공식 TypeScript/JavaScript 클라이언트 라이브러리입니다.

스타
831
포크
199
열린 이슈
20
마지막 커밋
어제

어떤 프로젝트인가요?

Cloudflare REST API를 위한 공식 서버 사이드 TypeScript 및 JavaScript 클라이언트입니다. zones, accounts, KV namespaces 등의 API 리소스를 요청 매개변수와 응답 필드 정의가 포함된 타입 지정 메서드로 제공하므로, 개발자는 HTTP 요청을 직접 작성하지 않고도 Cloudflare 서비스를 호출할 수 있습니다.

연결 오류와 408, 409, 429 및 5xx 응답에 대한 지수 백오프 자동 재시도, 설정 가능한 타임아웃, HTTP 상태 코드별 타입 지정 오류 클래스, `for await` 루프를 통한 목록 엔드포인트 자동 페이지네이션 등 자주 필요한 기능을 기본으로 제공합니다. 파일 업로드에는 Node 스트림, 웹 File 객체, fetch Response 또는 원시 바이트용 헬퍼를 사용할 수 있습니다.

브라우저, Node.js 20+, Deno, Bun, Cloudflare Workers 및 Vercel Edge Runtime에서 실행되며, 번들 크기를 줄이는 tree-shakable 진입점도 지원합니다. 라이브러리는 Stainless로 생성되었으며, 전체 메서드 목록은 api.md에서 확인할 수 있습니다.

핵심 기능

  • 01Cloudflare API 리소스에 대한 타입 지정 메서드 및 매개변수 정의
  • 02지수 백오프를 적용한 자동 재시도. maxRetries로 설정 가능
  • 03각 HTTP 상태 코드별 타입 지정 오류 클래스
  • 04for await 루프를 사용한 목록 엔드포인트 자동 페이지네이션
  • 05Node 스트림, File 객체 및 Response를 통한 파일 업로드 지원
  • 06선택한 리소스만 포함하는 tree-shakable 클라이언트

활용 사례

  • Node.js 배포 스크립트에서 DNS zone 생성 및 관리 자동화
  • 백엔드 서비스에서 Cloudflare KV namespace 또는 account 관리
  • 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 URL을 통해 설치해야 합니다.
  • 호출하려면 Cloudflare API 토큰이 필요합니다.

토픽

자주 묻는 질문

cloudflare-typescript은(는) 무엇인가요?
Stainless로 생성된 Cloudflare REST API용 공식 TypeScript/JavaScript 클라이언트 라이브러리입니다. Cloudflare REST API를 위한 공식 서버 사이드 TypeScript 및 JavaScript 클라이언트입니다. zones, accounts, KV namespaces 등의 API 리소스를 요청 매개변수와 응답 필드 정의가 포함된 타입 지정 메서드로 제공하므로, 개발자는 HTTP 요청을 직접 작성하지 않고도 Cloudflare 서비스를 호출할 수 있습니다.
cloudflare-typescript은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
cloudflare-typescript은(는) Apache-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
cloudflare-typescript은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. cloudflare-typescript의 마지막 커밋은 2026년 11월 5일입니다.
cloudflare-typescript은(는) 어디에 사용할 수 있나요?
Node.js 배포 스크립트에서 DNS zone 생성 및 관리 자동화 백엔드 서비스에서 Cloudflare KV namespace 또는 account 관리 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

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트