ExOsrsApi.Ratelimit (ExOsrsApi v0.1.1) View Source

Link to this section Summary

Link to this section Types

Specs

t() :: %ExOsrsApi.Ratelimit{
  limit: non_neg_integer(),
  timeout: non_neg_integer()
}

Link to this section Functions

Link to this function

check_ratelimit(ratelimit, type)

View Source

Specs

check_ratelimit(
  t(),
  :deadman
  | :hardcore_ironman
  | :ironman
  | :regular
  | :seasonal
  | :tournament
  | :ultimate_ironman
) :: {:ok, integer()} | {:error, ExOsrsApi.Errors.Error.t()}

Specs

Specs

new_default() :: %ExOsrsApi.Ratelimit{limit: 60, timeout: 60000}