From 2e2bf7c2edfe39ec173b7f8fa5121c80e6ad4de7 Mon Sep 17 00:00:00 2001 From: Tobe O Date: Wed, 14 Aug 2019 15:38:09 -0400 Subject: [PATCH] Update window docs --- lib/src/rate_limiting_window.dart | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/src/rate_limiting_window.dart b/lib/src/rate_limiting_window.dart index 1ac69f77..20d4492c 100644 --- a/lib/src/rate_limiting_window.dart +++ b/lib/src/rate_limiting_window.dart @@ -12,13 +12,22 @@ class RateLimitingWindow { final int pointsConsumed; /// The maximum amount of points allowed within a single window. + /// + /// This field is typically only set by the [RateLimiter] middleware, + /// and is therefore optional in the constructor. final int pointLimit; /// The amount of points the user can consume before hitting the /// rate limit for the current window. + /// + /// This field is typically only set by the [RateLimiter] middleware, + /// and is therefore optional in the constructor. final int remainingPoints; /// The time at which the window will reset. + /// + /// This field is typically only set by the [RateLimiter] middleware, + /// and is therefore optional in the constructor. final DateTime resetsAt; RateLimitingWindow(this.user, this.start, this.pointsConsumed,