1 Commits

Author SHA1 Message Date
68f31018ef style: standardize quotation marks and formatting in README.md
All checks were successful
CI / build (push) Successful in 17s
CI / publish (push) Successful in 15s
2025-09-06 19:36:14 +01:00

View File

@@ -25,46 +25,46 @@ npm install @3t/bennc
### Using the BenncClient (Recommended) ### Using the BenncClient (Recommended)
```typescript ```typescript
import { BenncClient, MessageTypes } from '@3t/bennc'; import { BenncClient, MessageTypes } from "@3t/bennc";
const client = new BenncClient({ const client = new BenncClient({
url: 'wss://your-bennc-server.com', url: "wss://your-bennc-server.com",
autoReconnect: true, autoReconnect: true,
reconnectBackoff: 'exponential', reconnectBackoff: "exponential",
reconnectDelay: 1000, reconnectDelay: 1000,
}); });
// Listen for events // Listen for events
client.addEventListener('connected', () => { client.addEventListener("connected", () => {
console.log('Connected to BENNC server'); console.log("Connected to BENNC server");
// Subscribe to basic messages // Subscribe to basic messages
client.subscribe(MessageTypes.Basic); client.subscribe(MessageTypes.Basic);
}); });
client.addEventListener('message:1', (event) => { client.addEventListener("message:1", (event) => {
const { senderId, data } = event.detail; const { senderId, data } = event.detail;
console.log(`Message from ${senderId}:`, new TextDecoder().decode(data)); console.log(`Message from ${senderId}:`, new TextDecoder().decode(data));
}); });
client.addEventListener('disconnected', (event) => { client.addEventListener("disconnected", (event) => {
console.log('Disconnected:', event.detail); console.log("Disconnected:", event.detail);
}); });
// Connect to server // Connect to server
await client.connect(); await client.connect();
// Send a message // Send a message
client.sendBasicMessage('Hello, BENNC!'); client.sendBasicMessage("Hello, BENNC!");
``` ```
### Using Low-Level Protocol Functions ### Using Low-Level Protocol Functions
```typescript ```typescript
import { packers, unpackers, MessageTypes } from '@3t/bennc'; import { packers, unpackers, MessageTypes } from "@3t/bennc";
// Pack a basic message // Pack a basic message
const messageData = new TextEncoder().encode('Hello World'); const messageData = new TextEncoder().encode("Hello World");
const packet = packers[MessageTypes.Basic](messageData); const packet = packers[MessageTypes.Basic](messageData);
// Unpack incoming message // Unpack incoming message
@@ -82,7 +82,7 @@ interface BenncClientOptions {
url: string; // WebSocket server URL url: string; // WebSocket server URL
protocols?: string[]; // WebSocket protocols protocols?: string[]; // WebSocket protocols
autoReconnect?: boolean; // Enable auto-reconnection (default: true) autoReconnect?: boolean; // Enable auto-reconnection (default: true)
reconnectBackoff?: 'constant' | 'exponential'; // Backoff strategy (default: 'exponential') reconnectBackoff?: "constant" | "exponential"; // Backoff strategy (default: 'exponential')
reconnectDelay?: number; // Reconnection delay in ms (default: 1000) reconnectDelay?: number; // Reconnection delay in ms (default: 1000)
maxReconnectAttempts?: number; // Max reconnection attempts (default: 10) maxReconnectAttempts?: number; // Max reconnection attempts (default: 10)
} }