View Source Storex.Store behaviour (storex v0.6.1)

Summary

Callbacks

init(session_id, params)

Called when store session starts.

mutation(name, data, session_id, params, state)

terminate(session_id, params, state)

Called when store session ends.

Callbacks

init(session_id, params)

@callback init(session_id :: binary(), params :: %{required(binary()) => any()}) ::
  {:ok, state :: any()}
  | {:ok, state :: any(), key :: binary()}
  | {:error, reason :: binary()}

Called when store session starts.

mutation(name, data, session_id, params, state)

@callback mutation(
  name :: binary(),
  data :: any(),
  session_id :: binary(),
  params :: %{required(binary()) => any()},
  state :: any()
) ::
  {:reply, message :: any(), state :: any()}
  | {:noreply, state :: any()}
  | {:error, state :: any()}

terminate(session_id, params, state)

(optional)

@callback terminate(
  session_id :: binary(),
  params :: %{required(binary()) => any()},
  state :: any()
) ::
  any()

Called when store session ends.