# Together
[]()
[](https://hexdocs.pm/together)
Group actions that can be handled / responded to later together
## What for?
- group notifications to be sent in *one* email
- cancel the previously queued email if another event happens within a short period (type: debounce)
- make heavy operations happen less often, i.e. refresh some global statistics
- allow only 1 operation per certain period (type: throttle)
- protect some write api
- additonally you can choose to use the first value in a period (keep: first)
- or the last value in the period (keep: last)
## Installation
**Elixir 1.4 is required**
The package can be installed as:
Add `together` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:together, "~> 0.5"}]
end
```
## How to use
Start `Together.Supervisor` to use it
- Start with application configs
```elixir
supervisor(Together.Supervisor, [])
```
- Start with configs passed in
```elixir
supervisor(Together.Supervisor, [workers: ..., store: ...])
```
Make calls to the worker process:
```elixir
Together.process(binary_name, "something_unique", some_func)
Together.process(pid, "some_unique_name_or_id", a_function)
Together.process(Together.Worker, "id", Module, :func, [arg1, arg2, ...])
```
## Example config
```elixir
config :together,
workers: [
# name is required, can be anything, prefer strings
[name: "throttled_job", delay: 30_000, type: :throttle],
[name: "debounced_job", delay: 5_000, type: :debounce],
[name: "keep_first_job", keep: :first],
# etc
],
# omissible, if you don't want to change anything
store: [
# name for the Store process
name: MyApp.Together.Store,
# name for the ExShards main process
shards_name: MyApp.Together.Store.Shards,
# for distributed ets
scope: :g,
# nodes in the cluster, will use `Node.list` if omitted
nodes: [:"node2@172.18.0.3", :"node3@172.18.0.4"]
]
```
## More ideas
- keep: all (seems to be touching `gen_stage` territory)
