Skip to main content

Node.js SDK

Node.js/TypeScript SDK for API integration

Overview

Node.js/TypeScript SDK for ComradeCircle.

NPM Packages

EnvironmentPackage NameVisibility
Alpha@burdenoff/alpha-comradecircle-sdk or @burdenoff/alpha-comradecircle-sdk-nodePrivate
Stable@burdenoff/comradecircle-sdk or @burdenoff/comradecircle-sdk-nodePublic

Installation

Public (Stable)

npm install @burdenoff/comradecircle-sdk

Private (Alpha)

npm login
npm install @burdenoff/alpha-comradecircle-sdk

Repository

Usage

import { ComradeCircleClient } from '@burdenoff/comradecircle-sdk';

const client = new ComradeCircleClient({
apiKey: process.env.COMRADECIRCLE_API_KEY
});

Features

  • Fully typed TypeScript API
  • GraphQL client
  • Authentication helpers
  • Error handling

See the NPM Package Management guide for more details.