Skip to content

Rate Limiting docs is misleading for Websockets example #3041

Open
@zenstok

Description

@zenstok

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions