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

Rate Limiting docs is misleading for Websockets example #3041

Open
1 of 5 tasks
zenstok opened this issue Jun 20, 2024 · 1 comment
Open
1 of 5 tasks

Rate Limiting docs is misleading for Websockets example #3041

zenstok opened this issue Jun 20, 2024 · 1 comment

Comments

@zenstok
Copy link

zenstok commented Jun 20, 2024

I'm submitting a...

  • Regression
  • Bug report
  • Feature request
  • Documentation issue or request (new chapter/page)
  • Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current Behavior

The NestJS 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. The handleRequest method will be called multiple times when multiple throttler limits are set.

Expected Behavior

The documentation should be updated to reflect that users need to handle multiple throttle limits if they are configured, rather than just a single limit. This ensures users are not misled into writing code that only handles one limit, which is no longer valid with multiple throttler limits configured.

@kamilmysliwiec
Copy link
Member

PRs are more than welcome if you're interested to contribute!

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

No branches or pull requests

2 participants