ash
ash v1.53.3

View Source Ash.Resource.Change behaviour (ash v1.53.3)

The behaviour for an action-specific resource change.

To implement one, simply implement the behaviour. init/1 is defined automatically by use Ash.Resource.Change, but can be implemented if you want to validate/transform any options passed to the module.

The main function is change/3. It takes the changeset, any options that were provided when this change was configured on a resource, and the context, which currently only has the actor.

Link to this section Summary

Types

context()
t()

Callbacks

change(t, t, context)
init(t)

Functions

action_schema()

Link to this section Types

Link to this type

context()

View Source 
@type context() :: %{actor: Ash.Resource.record()} | %{}
Link to this type

t()

View Source 
@type t() :: %Ash.Resource.Change{
  change: term(),
  description: term(),
  on: term(),
  only_when_valid?: term(),
  where: term()
}

Link to this section Callbacks

Link to this callback

change(t, t, context)

View Source 
@callback change(Ash.Changeset.t(), Keyword.t(), context()) :: Ash.Changeset.t()
Link to this callback

init(t)

View Source 
@callback init(Keyword.t()) :: {:ok, Keyword.t()} | {:error, term()}

Link to this section Functions

Link to this function

action_schema()

View Source