Websocket: Documentation

December 30, 2025 · View on GitHub

Entry points

Client - The WebSocket client
Server - The WebSocket server

Resources

Configuration - Configuration for Client and Server
Connection - The connection between client and server
Listener - Listeners allow callbacks when messages are received
Message - Represents a WebSocket message being sent or received
Middleware - Middlewares allow implementations to act incoming and outgoing messages

Developer resources

Changelog - The changelog of this repo
Contributing - Contributors and requirements
Examples - Examples
License - License
Class synopsis - Public API of core classes

Migration

v1 -> v2 - How to migrate from v1 to v2
v2 -> v3 - How to migrate from v2 to v3