Skip to content

feat:Add publish events over websocket docs #8270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 14, 2025
Merged

feat:Add publish events over websocket docs #8270

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36cc5eb
feat:Add publish events over websocket docs
zxl629 Feb 25, 2025
e063672
Fix spacing
zxl629 Feb 26, 2025
7cf6ff8
Add more clarity
zxl629 Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/pages/[platform]/build-a-backend/data/connect-event-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ export default function App() {

async function publishEvent() {
await events.post('default/channel', { some: 'data' });

// Alternative way to publish events through the channel
const channel = await events.connect('default/channel');
await channel.publish({ some: 'data' });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
await events.post('default/channel', { some: 'data' });
// Alternative way to publish events through the channel
const channel = await events.connect('default/channel');
await channel.publish({ some: 'data' });
// publish via HTTP POST
await events.post('default/channel', { some: 'data' });
// Alternatively, publish events through the WebSocket channel
const channel = await events.connect('default/channel');
await channel.publish({ some: 'data' });

looking at the content changes again I think it would be helpful to describe the differences between these two options. Although the API is clear in its intentions with .post(), adding a note will provide additional clarity especially when evaluating the alternative

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes sense, I have added a note for each option to clarify for the users.

}

return (
Expand Down Expand Up @@ -241,6 +245,10 @@ export default function App() {

async function publishEvent() {
await events.post('default/channel', { some: 'data' });

// Alternative way to publish events through the channel
const channel = await events.connect('default/channel');
await channel.publish({ some: 'data' });
}

return (
Expand Down