Ash.Signals

signals

Declare signals that resources can emit and listen to.

signals do
  signal :post_created do
    argument :post_id, :uuid, allow_nil?: false
  end
end

signal name

Declares a signal, and defines a struct for its arguments.

For a signal named :post_created in MyApp.Signals, this is MyApp.Signals.PostCreated.

signal :post_created do
  argument :post_id, :uuid, allow_nil?: false
end

Name	Type	Default	Docs
`name`	`atom`		The name of the signal.

Name	Type	Default	Docs
`phase`	`:before_action \| :after_action \| :after_transaction`	`:after_action`	The phase of the emitting action during which the signal may be emitted.
`description`	`String.t`		A description of the signal.

argument name, type

An argument of the signal, provided by the emitter.

argument :post_id, :uuid, allow_nil?: false

Name	Type	Default	Docs
`name`	`atom`		The name of the field.
`type`	`module`		The type of the field.

Name	Type	Default	Docs
`constraints`	`keyword`	`[]`	Constraints for the type.
`allow_nil?`	`boolean`	`true`	Whether the field may be `nil`.
`default`	`any`		A default value for the field.
`description`	`String.t`		A description of the field.