Warlock.Schema behaviour (warlock v2.1.0)

Summary

Types

Link to this type

query_result()

@type query_result() :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
@type user() :: atom() | String.t()

Callbacks

Link to this callback

delete(id, user)

(optional)
@callback delete(id :: any(), user :: user()) :: query_result()
Link to this callback

edit(params, id, user)

(optional)
@callback edit(params :: map(), id :: any(), user :: user()) :: query_result()
Link to this callback

get(params, user)

(optional)
@callback get(params :: map(), user :: user()) :: query_result()
Link to this callback

get_count(params, user)

(optional)
@callback get_count(params :: map(), user :: user()) :: query_result()
Link to this callback

new(params, user)

(optional)
@callback new(params :: map(), user :: user()) :: query_result()
Link to this callback

show(id, user)

(optional)
@callback show(id :: any(), user :: user()) :: query_result()
Link to this callback

update(item, params)

(optional)
@callback update(item :: Ecto.Schema.t(), params :: map()) :: query_result()