feat:Add publish events over websocket docs #8270
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
josefaidt
reviewed
Feb 25, 2025
| @@ -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 | |||
There was a problem hiding this comment.
Suggested change
| //Alternative way to publish events through the channel | |
| // Alternative way to publish events through the channel |
There was a problem hiding this comment.
tiny nit to align comment styles
josefaidt
reviewed
Feb 25, 2025
| @@ -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 | |||
There was a problem hiding this comment.
Suggested change
| //Alternative way to publish events through the channel | |
| // Alternative way to publish events through the channel |
josefaidt
reviewed
Feb 26, 2025
Comment on lines
85
to
89
| 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' }); |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
This makes sense, I have added a note for each option to clarify for the users.
josefaidt
approved these changes
Feb 26, 2025
iartemiev
approved these changes
Mar 12, 2025
stocaaro
approved these changes
Mar 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
Add examples of publishing events over WebSocket to the docs, this change aligns with the feature addition in this PR
Related GitHub issue #, if available:
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.