Skip to content

Commit 18876a5

Browse files
Merge pull request #3279 from tumeraltunbas/master
docs(rate-limiting): correct decorator name and usage
2 parents 2b10aad + 89d7b42 commit 18876a5

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

content/security/rate-limiting.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -354,9 +354,7 @@ For most people, wrapping your options in an array will be enough.
354354
If you are using a custom storage, you should wrap your `ttl` and `limit` in an
355355
array and assign it to the `throttlers` property of the options object.
356356

357-
Any `@ThrottleSkip()` should now take in an object with `string: boolean` props.
358-
The strings are the names of the throttlers. If you do not have a name, pass the
359-
string `'default'`, as this is what will be used under the hood otherwise.
357+
Any `@SkipThrottle()` decorator can be used to bypass throttling for specific routes or methods. It accepts an optional boolean parameter, which defaults to `true`. This is useful when you want to skip rate limiting on particular endpoints.
360358

361359
Any `@Throttle()` decorators should also now take in an object with string keys,
362360
relating to the names of the throttler contexts (again, `'default'` if no name)

0 commit comments

Comments
 (0)