pyers/prsm
1
0
Fork 0
mirror of https://github.com/nvms/prsm.git synced 2025-12-16 16:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

README

Browse Source
This commit is contained in:
nvms 2025-04-18 17:21:58 -04:00
parent c14dba183c
commit 1c797eb1ba
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
packages/mesh/README.md
View File

@ -2,7 +2,6 @@
Mesh is a command-based WebSocket framework for real-time apps—whether you're running a single server or a distributed cluster. It uses Redis to coordinate connections, rooms, and shared state across instances, with built-in support for structured commands, latency tracking, and automatic reconnection. Mesh is a command-based WebSocket framework for real-time apps—whether you're running a single server or a distributed cluster. It uses Redis to coordinate connections, rooms, and shared state across instances, with built-in support for structured commands, latency tracking, and automatic reconnection.
* [Quickstart](#quickstart) * [Quickstart](#quickstart)
* [Server](#server) * [Server](#server)
* [Client](#client) * [Client](#client)
@ -17,7 +16,7 @@ Mesh is a command-based WebSocket framework for real-time apps—whether you're
* [Server configuration](#server-configuration-1) * [Server configuration](#server-configuration-1)
* [Getting presence information (server-side)](#getting-presence-information-server-side) * [Getting presence information (server-side)](#getting-presence-information-server-side)
* [Client usage](#client-usage-1) * [Client usage](#client-usage-1)
* [Presence and metadata together](#presence-and-metadata-together) * [Combining presence with user info](#combining-presence-with-user-info)
* [Metadata](#metadata) * [Metadata](#metadata)
* [Room metadata](#room-metadata) * [Room metadata](#room-metadata)
* [Record subscriptions](#record-subscriptions) * [Record subscriptions](#record-subscriptions)
@ -270,7 +269,7 @@ When presence is enabled for a room, Mesh automatically:
1. Tracks which connections are present in the room 1. Tracks which connections are present in the room
2. Emits presence events when connections join or leave 2. Emits presence events when connections join or leave
3. Refreshes presence TTL when connections send pong responses 3. Refreshes each connection's presence TTL automatically as long as it remains connected and responding to pings
4. Cleans up presence when connections disconnect 4. Cleans up presence when connections disconnect
### Getting presence information (server-side) ### Getting presence information (server-side)
@ -306,7 +305,7 @@ Unsubscribe when no longer needed:
await client.unsubscribePresence("lobby"); await client.unsubscribePresence("lobby");
``` ```
### Presence and metadata together ### Combining presence with user info
Presence is most useful when combined with connection metadata. For example: Presence is most useful when combined with connection metadata. For example: