Commit 18876a5

authored

Merge pull request #3279 from tumeraltunbas/master

docs(rate-limiting): correct decorator name and usage

2 parents 2b10aad + 89d7b42 commit 18876a5Copy full SHA for 18876a5

File tree

-3

lines changed

-3

lines changed

Lines changed: 1 addition & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -354,9 +354,7 @@ For most people, wrapping your options in an array will be enough.`
`354`	`354`	If you are using a custom storage, you should wrap your `ttl` and `limit` in an
`355`	`355`	array and assign it to the `throttlers` property of the options object.
`356`	`356`
`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.
`360`	`358`
`361`	`359`	Any `@Throttle()` decorators should also now take in an object with string keys,
`362`	`360`	relating to the names of the throttler contexts (again, `'default'` if no name)

Comments

(0)