@feedsync/sdk
v1.0.0
Published
JavaScript/TypeScript SDK for FeedSync — real-time event tracking and feeds
Maintainers
Readme
@feedsync/sdk
JavaScript/TypeScript SDK for FeedSync — real-time event tracking, activity feeds, and live subscriptions.
Installation
npm install @feedsync/sdkUsage
import { FeedSync } from "@feedsync/sdk";
const feed = new FeedSync({
apiUrl: "https://your-server.com",
apiKey: "fs_live_your_key_here",
});
// track an event
await feed.track({
userId: "user_123",
type: "order_created",
data: { orderId: "ord_456", amount: 99.99 },
});
// subscribe to live events
const unsubscribe = feed.subscribe("user_123", (event) => {
console.log(event.type, event.data);
});
// fetch historical feed
const events = await feed.getFeed("user_123", 20);
// unsubscribe
unsubscribe();Event type rules
Types must match /^[a-zA-Z0-9_.-]+$/ — letters, numbers, underscores, dots, hyphens. No spaces.
ESM only
This package ships ESM only. It works in all modern bundlers (Vite, Next.js app router, esbuild). For CommonJS environments, use a dynamic import().
