attach has been replaced by installHandlers #299
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
There was a problem hiding this comment.
Pull Request Overview
Updates documentation to reflect a breaking API change where the attach method has been replaced with installHandlers in the SockJS library. This ensures the README provides accurate usage examples for the current API.
- Replaces all instances of
echo.attach()andsockjs_server.attach()withinstallHandlers() - Updates corresponding documentation text to reference the new method name
| @@ -197,7 +197,7 @@ and emits following event: | |||
| All http requests that don't go under the path selected by `prefix` | |||
| will remain unanswered and will be passed to previously registered | |||
| handlers. You must install your custom http handlers before calling | |||
| `attach`. You can remove the SockJS handler later with `detach`. | |||
| `installHandlers`. You can remove the SockJS handler later with `detach`. | |||
There was a problem hiding this comment.
The documentation mentions that handlers can be removed with detach, but if attach has been replaced with installHandlers, the removal method may have also changed. Consider verifying if detach is still the correct method name or if it should be updated to match the new API.
Suggested change
| `installHandlers`. You can remove the SockJS handler later with `detach`. | |
| `installHandlers`. You can remove the SockJS handler later with `uninstallHandlers`. |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
can you please cross check this review?
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.
No description provided.