Unchange SDK Documentation
Official documentation for the Unchange SDK
Unchange SDK
The Unchange SDK is a TypeScript/JavaScript client for interacting with the Unchange API. It provides a simple and type-safe way to manage changelogs and users in your application.
Features
- 🔒 Type-safe: Built with TypeScript for excellent IDE support
- 🚀 Easy to use: Simple and intuitive API
- 📦 Lightweight: Minimal dependencies
- ⚡ Promise-based: Modern async/await syntax
- 🔧 Configurable: Support for custom base URLs
Quick Start
Install the package and initialize the client:
npm install unchange-sdkimport { Unchange } from 'unchange-sdk';
const client = new Unchange({
apiKey: 'your-api-key',
projectId: 'your-project-id',
});
// Fetch all changelogs
const changelogs = await client.changelogs.list();
// Get latest changelog for a user
const latest = await client.changelogs.getLatestForUser('user-123');
// Mark changelog as seen
await client.changelogs.acknowledge(latest._id, 'user-123');