AshEvents.Events.Info (ash_events v0.1.1)

View Source

@moduledoc "Introspection helpers for AshEvents.Events"

Summary

Functions

A keyword list of action versions. This will be used to set the version in the created events when the actions are run. Version will default to 1 for all actions that are not listed here.

A keyword list of action versions. This will be used to set the version in the created events when the actions are run. Version will default to 1 for all actions that are not listed here.

The event-log resource that creates and stores events.

The event-log resource that creates and stores events.

A list of actions that should not have events created when run.

A list of actions that should not have events created when run.

events DSL options

Functions

events_current_action_versions(dsl_or_extended)

@spec events_current_action_versions(dsl_or_extended :: module() | map()) ::
  {:ok, keyword()} | :error

A keyword list of action versions. This will be used to set the version in the created events when the actions are run. Version will default to 1 for all actions that are not listed here.

events_current_action_versions!(dsl_or_extended)

@spec events_current_action_versions!(dsl_or_extended :: module() | map()) ::
  keyword() | no_return()

A keyword list of action versions. This will be used to set the version in the created events when the actions are run. Version will default to 1 for all actions that are not listed here.

events_event_log(dsl_or_extended)

@spec events_event_log(dsl_or_extended :: module() | map()) ::
  {:ok, module()} | :error

The event-log resource that creates and stores events.

events_event_log!(dsl_or_extended)

@spec events_event_log!(dsl_or_extended :: module() | map()) :: module() | no_return()

The event-log resource that creates and stores events.

events_ignore_actions(dsl_or_extended)

@spec events_ignore_actions(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

A list of actions that should not have events created when run.

events_ignore_actions!(dsl_or_extended)

@spec events_ignore_actions!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

A list of actions that should not have events created when run.

events_options(dsl_or_extended)

@spec events_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

events DSL options

Returns a map containing the and any configured or default values.