CounterEx v0.1.0 CounterEx View Source

Documentation for CounterEx.

Link to this section Summary

all()

Returns all the counters as list ex. [{key, value}....{key, value}]

Returns the value of the counter or nil

Create/Update the counter by 1 (default) or custom step. Returns the new value

Reset the value of a counter to 0 or custom step

Set the value of a counter to 0 or custom step

all() :: [tuple(), ...]

Returns all the counters as list ex. [{key, value}....{key, value}]

iex> CounterEx.all
nil
iex> CounterEx.inc("sample.key") && CounterEx.all
[{"sample.key", 1}]

get(binary()) :: nil | integer()

Returns the value of the counter or nil

iex> CounterEx.get("sample.key")
nil
iex> CounterEx.inc("sample.key") && CounterEx.get("sample.key")
1

Create/Update the counter by 1 (default) or custom step. Returns the new value

iex> CounterEx.inc("sample.key")
1
iex> CounterEx.inc("sample.key")
2
iex> CounterEx.inc(:sample_key)
1

Reset the value of a counter to 0 or custom step

iex> CounterEx.reset("test.key")
true

set(binary(), integer()) :: boolean()

Set the value of a counter to 0 or custom step

iex> CounterEx.set("test.key")
true

start_keeper() :: {CounterEx.Keeper, []}

start_keeper_with_sweep(integer()) ::
  {CounterEx.Keeper, [{:interval, integer()}, ...]}