mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add errorMessage

Browse source
This commit is contained in:
Tobe O 2019-08-14 15:22:00 -04:00
parent 0f6011d693
commit 7ce51b1581
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lib/src/rate_limiter.dart
View file

@ -18,7 +18,15 @@ abstract class RateLimiter<User> {
/// more than [maxPointsPerWindow].
final Duration windowDuration;
RateLimiter(this.maxPointsPerWindow, this.windowDuration);
/// The error message to send to a [User] who has exceeded the
/// rate limit during the current window.
///
/// This only applies to the default implementation of
/// [denyRequest].
final String errorMessage;
RateLimiter(this.maxPointsPerWindow, this.windowDuration,
{this.errorMessage});
/// Computes the current window in which the user is acting.
///