AshTypescript.TypedChannel.Info (ash_typescript v0.17.3)

Provides introspection functions for AshTypescript.TypedChannel configuration.

Summary

typed_channel DSL entities

Whether or not a given module uses the AshTypescript.TypedChannel DSL.

typed_channel DSL options

The Phoenix channel topic pattern (e.g. "org:*").

The Phoenix channel topic pattern (e.g. "org:*").

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

typed_channel DSL entities

@spec typed_channel?(module()) :: boolean()

Whether or not a given module uses the AshTypescript.TypedChannel DSL.

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

typed_channel DSL options

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

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

The Phoenix channel topic pattern (e.g. "org:*").

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

The Phoenix channel topic pattern (e.g. "org:*").