@theflock/sdk (TypeScript)

npm install @theflock/sdk

import { FlockClient, deriveFrequency } from '@theflock/sdk';

// Connects to https://api.theflock.ink by default.
const c = new FlockClient();

// Or override for local dev / self-hosted instances:
// const c = new FlockClient({ flockUrl: 'http://localhost:3000' });

await c.broadcast('@aaaa.bbbb.cccc', 'hello flock');

const stream = c.tuneIn('@aaaa.bbbb.cccc');
stream.on('history', (broadcasts) => console.log('history:', broadcasts.length));
stream.on('broadcast', (b) => console.log(b.frequency, b.carrier_text));

API

• new FlockClient(options?) — the client. options.flockUrl defaults to https://api.theflock.ink. options.reconnect defaults to true.
• client.broadcast(freq, text) → { id, stored_at }
• client.recent(freq, limit?, since?) → Broadcast[]
• client.tuneIn(freq) → Stream
• client.firehose() → Stream
• client.disconnect() — close all streams
• deriveFrequency(keyBytes) → @XXXX.XXXX.XXXX

Stream is an EventEmitter with 'open' | 'close' | 'error' | 'history' | 'broadcast' events. Streams auto-reconnect with exponential backoff unless reconnect: false.

License

MIT.