Skip to content

Installation

Get started with the official MsGine TypeScript SDK.

Prerequisites

  • Node.js 16.x or higher
  • npm, pnpm, or yarn package manager

Install the SDK

bash
pnpm add @msgine/sdk
bash
npm install @msgine/sdk
bash
yarn add @msgine/sdk

Verify Installation

Create a test file to verify the installation:

typescript
import { MsGineClient } from '@msgine/sdk'

console.log('MsGine SDK installed successfully!')

Run the file:

bash
node --loader ts-node/esm test.ts

Features

The MsGine SDK includes:

  • Fully Typed - Complete TypeScript support with strict typing
  • Auto Retry - Configurable retry logic with exponential backoff
  • Validation - Runtime validation using Zod schemas
  • Modern - Built with latest TypeScript and ES modules
  • Well Tested - Comprehensive test coverage
  • Zero Config - Sensible defaults, easy to customize
  • Flexible - Support for custom fetch implementations

What's Next?

Getting Help

If you encounter any issues:

Released under the MIT License.