docs(throttler): update WebSockets example for multiple throttle limits #3242
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Currently, the documentation for WebSockets and rate limiting provides an example of using the throttler guard with WebSockets. However, it does not take into account multiple throttle limit configurations and does not explain that the
handleRequest
method will be called multiple times when multiple throttler limits are set.So, This PR updates the Throttler documentation for WebSockets to fix issue #3041. The current WebSockets example doesn't properly explain how multiple throttle limit configurations are handled, which can lead to incorrect implementations.
What is the new behavior?
handleRequest
is called for each throttle configuration when multiple limits are definedDoes this PR introduce a breaking change?
Other information
The documentation now clearly explains how multiple throttle limits work with WebSockets and provides a comprehensive example. Users will understand that they need to handle multiple throttle limits if they are configured, rather than just a single limit.