Last Updated: 1/27/2026

Installation

Install the SDK using your preferred package manager.

Package Managers

npm


npm install @example/sdk

yarn


yarn add @example/sdk

pnpm


pnpm add @example/sdk

:::note Requires Node.js 18 or higher. Check your version with node --version. :::

Verify Installation


import { Client, VERSION } from '@example/sdk';
 
console.log(`SDK Version: ${VERSION}`);
 
const client = new Client();
const health = await client.healthCheck();
 
if (health.ok) {
  console.log('Connection successful!');
}

TypeScript Setup


// tsconfig.json
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "strict": true,
    "esModuleInterop": true
  }
}

:::tip Enable strict mode for the best type inference with our SDK. :::

Peer Dependencies

Package	Version	Required
`typescript`	`^5.0.0`	Optional
`zod`	`^3.0.0`	Optional


# Install optional peer dependencies
npm install typescript zod

:::danger Using Node.js versions below 18 is not supported and may cause unexpected errors. :::

Troubleshooting

Module Not Found


# Clear npm cache and reinstall
rm -rf node_modules package-lock.json
npm install

TypeScript Errors


// If you see "Cannot find module" errors:
// 1. Check your tsconfig.json moduleResolution
// 2. Ensure @types/node is installed
 
npm install -D @types/node

:::warning If issues persist, check our troubleshooting guide or open an issue on GitHub. :::