Skip to content

Revise pushEvent / pushEventTo docs#4220

Merged
SteffenDE merged 1 commit into
phoenixframework:mainfrom
rhcarvalho:pushevent-docs
May 8, 2026
Merged

Revise pushEvent / pushEventTo docs#4220
SteffenDE merged 1 commit into
phoenixframework:mainfrom
rhcarvalho:pushevent-docs

Conversation

@rhcarvalho

Copy link
Copy Markdown
Contributor

For the TS API docs, document each method signature independently, so that each one can focus on its particular behavior. This makes the generated API docs easier to consume and link to.

For the summarized JS interop guide, mention that the callback version of those methods silently ignores errors as the key distinction between the two versions.

Rephrase the pushEventTo guide prose to avoid discussing the selectorOrTarget parameter twice.

Closes #4075.

For the TS API docs, document each method signature independently, so that each
one can focus on its particular behavior. This makes the generated API docs
easier to consume and link to.

For the summarized JS interop guide, mention that the callback version of those
methods silently ignores errors as the key distinction between the two versions.

Rephrase the `pushEventTo` guide prose to avoid discussing the
`selectorOrTarget` parameter twice.
@SteffenDE SteffenDE merged commit 3be2d2a into phoenixframework:main May 8, 2026
8 checks passed
@SteffenDE

Copy link
Copy Markdown
Member

🙌

@rhcarvalho rhcarvalho deleted the pushevent-docs branch May 8, 2026 09:57
SteffenDE pushed a commit that referenced this pull request May 29, 2026
For the TS API docs, document each method signature independently, so that each
one can focus on its particular behavior. This makes the generated API docs
easier to consume and link to.

For the summarized JS interop guide, mention that the callback version of those
methods silently ignores errors as the key distinction between the two versions.

Rephrase the `pushEventTo` guide prose to avoid discussing the
`selectorOrTarget` parameter twice.
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.

Client side failed with reason: {"reason":"unmatched topic"} errors (WebSocket)

2 participants