AshTypescript.TypedController.Info (ash_typescript v0.17.2)

Copy Markdown View Source

Provides introspection functions for AshTypescript.TypedController configuration.

Summary

Functions

typed_controller DSL entities

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

The module name for the generated Phoenix controller (e.g. MyAppWeb.SessionController)

The module name for the generated Phoenix controller (e.g. MyAppWeb.SessionController)

Default namespace (filename) for all routes in this controller. Can be overridden per-route.

Default namespace (filename) for all routes in this controller. Can be overridden per-route.

typed_controller DSL options

Functions

typed_controller(dsl_or_extended)

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

typed_controller DSL entities

typed_controller?(module)

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

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

typed_controller_module_name(dsl_or_extended)

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

The module name for the generated Phoenix controller (e.g. MyAppWeb.SessionController)

typed_controller_module_name!(dsl_or_extended)

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

The module name for the generated Phoenix controller (e.g. MyAppWeb.SessionController)

typed_controller_namespace(dsl_or_extended)

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

Default namespace (filename) for all routes in this controller. Can be overridden per-route.

typed_controller_namespace!(dsl_or_extended)

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

Default namespace (filename) for all routes in this controller. Can be overridden per-route.

typed_controller_options(dsl_or_extended)

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

typed_controller DSL options

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