Add optional info field to offers

- Add info field to CreateOfferRequest and Offer types
- Update README with info field examples and documentation
- Public metadata field visible in all API responses

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
2025-11-22 17:34:11 +01:00
parent 83fd0f84a4
commit 255fe42a43
2 changed files with 6 additions and 2 deletions

View File

@@ -411,7 +411,8 @@ const offers = await client.offers.create([{
sdp: 'v=0...', // Your WebRTC offer SDP sdp: 'v=0...', // Your WebRTC offer SDP
topics: ['movie-xyz', 'hd-content'], topics: ['movie-xyz', 'hd-content'],
ttl: 300000, // 5 minutes ttl: 300000, // 5 minutes
secret: 'my-secret-password' // Optional: protect offer (max 128 chars) secret: 'my-secret-password', // Optional: protect offer (max 128 chars)
info: 'Looking for peers in EU region' // Optional: public info (max 128 chars)
}]); }]);
// Discover peers by topic // Discover peers by topic
@@ -489,7 +490,8 @@ const offers = await client.offers.create([
sdp: 'v=0...', sdp: 'v=0...',
topics: ['topic-1', 'topic-2'], topics: ['topic-1', 'topic-2'],
ttl: 300000, // optional, default 5 minutes ttl: 300000, // optional, default 5 minutes
secret: 'my-secret-password' // optional, max 128 chars secret: 'my-secret-password', // optional, max 128 chars
info: 'Looking for peers in EU region' // optional, public info, max 128 chars
} }
]); ]);
``` ```

View File

@@ -9,6 +9,7 @@ export interface CreateOfferRequest {
topics: string[]; topics: string[];
ttl?: number; ttl?: number;
secret?: string; secret?: string;
info?: string;
} }
export interface Offer { export interface Offer {
@@ -21,6 +22,7 @@ export interface Offer {
lastSeen: number; lastSeen: number;
secret?: string; secret?: string;
hasSecret?: boolean; hasSecret?: boolean;
info?: string;
answererPeerId?: string; answererPeerId?: string;
answerSdp?: string; answerSdp?: string;
answeredAt?: number; answeredAt?: number;