xtr.dev/rondevu-client
1
0
Fork 0
mirror of https://github.com/xtr-dev/rondevu-client.git synced 2025-12-10 02:43:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename methods to match WebRTC terminology

Browse Source 
- Rename create() → offer() to align with WebRTC offer creation
- Rename connect() → answer() to align with WebRTC answer handling
- Update README with new method names and examples
- Version 0.3.3

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Bas van den Aakster
2025-11-12 23:29:04 +01:00
parent c8e5e4d17a
commit d200d73cd9
3 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -39,11 +39,11 @@ const rdv = new Rondevu({
} }
}); });
// Create a connection with custom ID // Create an offer with custom ID
const connection = await rdv.create('my-room-123'); const connection = await rdv.offer('my-room-123');
// Or connect to an existing connection // Or answer an existing offer
const connection = await rdv.connect('my-room-123'); const connection = await rdv.answer('my-room-123');
// Use data channels // Use data channels
connection.on('connect', () => { connection.on('connect', () => {
@@ -77,7 +77,7 @@ const rdv = new Rondevu({
} }
}); });
const connection = await rdv.create('my-room-123'); const connection = await rdv.offer('my-room-123');
connection.on('connect', () => { connection.on('connect', () => {
const channel = connection.dataChannel('chat'); const channel = connection.dataChannel('chat');
@@ -88,8 +88,8 @@ connection.on('connect', () => {
### API ### API
**Main Methods:** **Main Methods:**
- `rdv.create(id)` - Create connection with custom ID - `rdv.offer(id)` - Create an offer with custom ID
- `rdv.connect(id)` - Connect to existing connection by ID - `rdv.answer(id)` - Answer an existing offer by ID
**Connection Events:** **Connection Events:**
- `connect` - Connection established - `connect` - Connection established

2
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "@xtr-dev/rondevu-client", "name": "@xtr-dev/rondevu-client",
"version": "0.3.2", "version": "0.3.3",
"description": "TypeScript client for Rondevu peer signaling and discovery server", "description": "TypeScript client for Rondevu peer signaling and discovery server",
"type": "module", "type": "module",
"main": "dist/index.js", "main": "dist/index.js",

12
src/rondevu.ts
View File

@@ -62,7 +62,7 @@ export class Rondevu {
private async checkServerVersion(): Promise<void> { private async checkServerVersion(): Promise<void> {
try { try {
const { version: serverVersion } = await this.api.health(); const { version: serverVersion } = await this.api.health();
const clientVersion = '0.3.2'; // Should match package.json const clientVersion = '0.3.3'; // Should match package.json
if (!this.isVersionCompatible(clientVersion, serverVersion)) { if (!this.isVersionCompatible(clientVersion, serverVersion)) {
console.warn( console.warn(
@@ -103,11 +103,11 @@ export class Rondevu {
} }
/** /**
* Create a new connection (offerer role) * Create an offer (offerer role)
* @param id - Connection identifier (custom code) * @param id - Offer identifier (custom code)
* @returns Promise that resolves to RondevuConnection * @returns Promise that resolves to RondevuConnection
*/ */
async create(id: string): Promise<RondevuConnection> { async offer(id: string): Promise<RondevuConnection> {
// Create peer connection // Create peer connection
const pc = new this.RTCPeerConnection(this.rtcConfig); const pc = new this.RTCPeerConnection(this.rtcConfig);
@@ -149,11 +149,11 @@ export class Rondevu {
} }
/** /**
* Connect to an existing offer by ID (answerer role) * Answer an existing offer by ID (answerer role)
* @param id - Offer code * @param id - Offer code
* @returns Promise that resolves to RondevuConnection * @returns Promise that resolves to RondevuConnection
*/ */
async connect(id: string): Promise<RondevuConnection> { async answer(id: string): Promise<RondevuConnection> {
// Poll server to get offer by ID // Poll server to get offer by ID
const offerData = await this.findOfferById(id); const offerData = await this.findOfferById(id);