Skip to content
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.

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

Update Event Stream Documentation with Customization Options #10215

Draft
wants to merge 1 commit into
base: 12.x
Choose a base branch
from

Conversation

mohammadrasoulasghari
Copy link
Contributor

This PR updates the documentation for Event Stream to reflect the new customization options introduced in Enhance eventStream to Support Custom Events and Start Messages.

Updates include:

  • Documentation for changing default event names using the 'as' parameter
  • Examples of creating custom event types with the EventStream class
  • JavaScript code samples showing how to consume different event types
  • Documentation for the new startStreamWith and endStreamWith options
  • Examples showing how to handle stream lifecycle events

- Added detailed explanation of event stream customization options
- Included examples for changing default event names with 'as' parameter
- Added documentation for custom event types using EventStream class
- Included JavaScript code samples for consuming different event types
- Added examples for custom start and end stream messages
@taylorotwell taylorotwell marked this pull request as draft February 28, 2025 17:11
@taylorotwell
Copy link
Member

Drafting until release day.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants