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

README

Browse Source
This commit is contained in:
nvms 2025-04-17 16:42:50 -04:00
parent 8a84f6ea04
commit bffefe344a
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
packages/mesh/README.md
View File

@ -134,6 +134,27 @@ server.exposeChannel(/^private:chat:.+$/, async (conn, channel) => {
});
```
#### Server Publishing
To publish messages to a channel (which subscribed clients will receive), use the `publishToChannel` method. You can optionally store a history of recent messages in Redis.
```ts
// publish to 'notifications:global' without history
await server.publishToChannel(
"notifications:global",
JSON.stringify({ alert: "Red alert!" })
);
// publish a chat message and keep the last 50 messages in history
await server.publishToChannel(
"chat:room1",
JSON.stringify({ type: "user-message", user: "1", text: "Hi" }),
50 // store in Redis history
);
```
The `history` parameter tells Mesh to store the message in a Redis list (`history:<channel>`) and trim the list to the specified size, ensuring only the most recent messages are kept. Clients subscribing with the `historyLimit` option will receive these historical messages upon connection.
#### Client Usage
```ts