adds some documentation

splashbyte · Jul 28, 2024 · d0cba2f · d0cba2f
1 parent 9e97860
commit d0cba2f
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/src/token_bucket_storage.dart b/lib/src/token_bucket_storage.dart
@@ -6,8 +6,12 @@ import 'package:token_bucket_algorithm/token_bucket_algorithm.dart';
 abstract class AsyncTokenBucketStorage {
   const AsyncTokenBucketStorage();
 
+  /// Gets the current [TokenBucketState] stored by this storage.
+  ///
+  /// Returns [null] if no state is available.
   FutureOr<TokenBucketState?> get();
 
+  /// Overwrites the currently stored [TokenBucketState] of this storage.
   FutureOr<void> set(TokenBucketState state);
 }