docblock

src/Limit.php

@@ -63,25 +63,37 @@ public static function allow(int $maxAttempts, int $expiresMinutes = 60): self
         return new self($maxAttempts, $expiresMinutes * 60);
     }
 
+    /**
+     * Get the limit key for caching.
+     */
     public function key(): string
     {
         $prefix = 'fansipan_rate_limit';
 
         return $prefix.'_'.$this->name;
     }
 
+    /**
+     * Get the limit max request attempts.
+     */
     public function maxAttempts(bool $includeThreshold = true): int
     {
         return $includeThreshold
             ? (int) \round($this->maxAttempts * $this->threshold, \PHP_ROUND_HALF_DOWN)
             : $this->maxAttempts;
     }
 
+    /**
+     * Get the expiration time in millisecond.
+     */
     public function expiresAfter(): int
     {
         return $this->expiresAfter;
     }
 
+    /**
+     * Set a custom name for the limit.
+     */
     public function withName(string $name): self
     {
         $clone = clone $this;