Skip to main content

Node.js SDK

Node.js/TypeScript SDK for API integration

Overview​

Node.js/TypeScript SDK for PlanMagnet.

NPM Packages​

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

Installation​

Public (Stable)​

npm install @burdenoff/planmagnet-sdk

Private (Alpha)​

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

Repository​

Usage​

import { PlanMagnetClient } from '@burdenoff/planmagnet-sdk';

const client = new PlanMagnetClient({
  apiKey: process.env.PLANMAGNET_API_KEY
});

Features​

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

See the NPM Package Management guide for more details.