AshJido.Info (AshJido v1.0.0)

Copy Markdown View Source

Introspection helpers for AshJido DSL configuration.

Summary

Functions

jido DSL entities

The Jido.Signal.Bus server to publish resource-change signals to. Falls back to config :ash_jido, :signal_bus if not set.

The Jido.Signal.Bus server to publish resource-change signals to. Falls back to config :ash_jido, :signal_bus if not set.

Prefix used for auto-derived signal types. Falls back to config :ash_jido, :signal_prefix, "ash".

Prefix used for auto-derived signal types. Falls back to config :ash_jido, :signal_prefix, "ash".

Returns all compiled publication configs for the resource

Returns the signal bus configured for the resource

Returns the signal prefix configured for the resource

Functions

jido(dsl_or_extended)

@spec jido(dsl_or_extended :: module() | map()) :: [struct()]

jido DSL entities

jido_options(dsl_or_extended)

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

jido DSL options

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

jido_signal_bus(dsl_or_extended)

@spec jido_signal_bus(dsl_or_extended :: module() | map()) ::
  {:ok, atom() | mfa()} | :error

The Jido.Signal.Bus server to publish resource-change signals to. Falls back to config :ash_jido, :signal_bus if not set.

jido_signal_bus!(dsl_or_extended)

@spec jido_signal_bus!(dsl_or_extended :: module() | map()) ::
  (atom() | mfa()) | no_return()

The Jido.Signal.Bus server to publish resource-change signals to. Falls back to config :ash_jido, :signal_bus if not set.

jido_signal_prefix(dsl_or_extended)

@spec jido_signal_prefix(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

Prefix used for auto-derived signal types. Falls back to config :ash_jido, :signal_prefix, "ash".

jido_signal_prefix!(dsl_or_extended)

@spec jido_signal_prefix!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

Prefix used for auto-derived signal types. Falls back to config :ash_jido, :signal_prefix, "ash".

publications(resource)

@spec publications(Ash.Resource.t()) :: {:ok, [AshJido.Publication.t()]} | :error

Returns all compiled publication configs for the resource

signal_bus(resource)

@spec signal_bus(Ash.Resource.t()) :: {:ok, term()} | :error

Returns the signal bus configured for the resource

signal_prefix(resource)

@spec signal_prefix(Ash.Resource.t()) :: {:ok, String.t()} | :error

Returns the signal prefix configured for the resource