@spec check(atom(), String.t(), keyword()) :: :ok | {:error, :rate_limited}

Check if an action is allowed under rate limits.

Example

case Raxol.RateLimit.check(:login, user_ip) do
  :ok -> process_login()
  {:error, :rate_limited} -> reject_request()
end

Returns a specification to start this module under a supervisor.

See Supervisor.

@spec configure(
  atom(),
  keyword()
) :: :ok

Configure custom limits for an action.

Example

Raxol.RateLimit.configure(:custom_action, limit: 50, window: 30_000)

@spec remaining(atom(), String.t(), keyword()) :: non_neg_integer()

Get remaining requests in the current window.

Example

remaining = Raxol.RateLimit.remaining(:api, user_id)
# => 95

@spec reset(atom(), String.t()) :: :ok

Reset rate limit for an identifier.

Example

:ok = Raxol.RateLimit.reset(:login, user_ip)

@spec reset_in(atom(), String.t(), keyword()) :: non_neg_integer()

Get time until rate limit resets.

Example

ms = Raxol.RateLimit.reset_in(:login, user_ip)
# => 45000 (milliseconds)

Start the rate limiter agent.

Usually started automatically by the application supervisor.