api/laravel/Support/Facades/RateLimiter.yaml
2024-09-26 02:03:21 -07:00

93 lines
2.4 KiB
YAML

name: RateLimiter
class_comment: '# * @method static \Illuminate\Cache\RateLimiter for(string $name,
\Closure $callback)
# * @method static \Closure|null limiter(string $name)
# * @method static mixed attempt(string $key, int $maxAttempts, \Closure $callback,
int $decaySeconds = 60)
# * @method static bool tooManyAttempts(string $key, int $maxAttempts)
# * @method static int hit(string $key, int $decaySeconds = 60)
# * @method static int increment(string $key, int $decaySeconds = 60, int $amount
= 1)
# * @method static int decrement(string $key, int $decaySeconds = 60, int $amount
= 1)
# * @method static mixed attempts(string $key)
# * @method static mixed resetAttempts(string $key)
# * @method static int remaining(string $key, int $maxAttempts)
# * @method static int retriesLeft(string $key, int $maxAttempts)
# * @method static void clear(string $key)
# * @method static int availableIn(string $key)
# * @method static string cleanRateLimiterKey(string $key)
# *
# * @see \Illuminate\Cache\RateLimiter'
dependencies: []
properties: []
methods:
- name: getFacadeAccessor
visibility: protected
parameters: []
comment: '# * @method static \Illuminate\Cache\RateLimiter for(string $name, \Closure
$callback)
# * @method static \Closure|null limiter(string $name)
# * @method static mixed attempt(string $key, int $maxAttempts, \Closure $callback,
int $decaySeconds = 60)
# * @method static bool tooManyAttempts(string $key, int $maxAttempts)
# * @method static int hit(string $key, int $decaySeconds = 60)
# * @method static int increment(string $key, int $decaySeconds = 60, int $amount
= 1)
# * @method static int decrement(string $key, int $decaySeconds = 60, int $amount
= 1)
# * @method static mixed attempts(string $key)
# * @method static mixed resetAttempts(string $key)
# * @method static int remaining(string $key, int $maxAttempts)
# * @method static int retriesLeft(string $key, int $maxAttempts)
# * @method static void clear(string $key)
# * @method static int availableIn(string $key)
# * @method static string cleanRateLimiterKey(string $key)
# *
# * @see \Illuminate\Cache\RateLimiter
# */
# class RateLimiter extends Facade
# {
# /**
# * Get the registered name of the component.
# *
# * @return string'
traits: []
interfaces: []