#Alepha - Websocket

#Installation

Part of the alepha package. Import from alepha/websocket.

npm install alepha

#Overview

Real-time bidirectional communication.

Features:

• WebSocket server definition
• Named communication channels
• Type-safe message handling
• Connection lifecycle management
• Room/channel grouping
• Browser compatibility

#API Reference

#Primitives

• $channel — Defines a WebSocket channel with specified client and server message schemas.
• $room — Defines a stateful WebSocket room — the home for an authoritative,
• $websocket — Defines a WebSocket server endpoint for a specific channel.

#Providers

• AlephaWebSocketDurableObject — Durable Object that hosts one room's WebSocket connections on Cloudflare.
• CloudflareDurableObjectWebSocketServerProvider — WebSocket server provider backed by Cloudflare Durable Objects.
• RoomEngine — Runtime-neutral heart of a stateful room: it owns the in-memory state, the
• WebSocketRoom — All the logic for hosting one room's hibernatable WebSockets on Cloudflare.

#Environment Variables

Environment variables used to configure this module. These can be set in your .env file or through your deployment configuration.