Beacon.LiveAdmin.Config (Beacon LiveAdmin v0.4.2)

Configuration for Admin instances.

See new/1 for available options and examples.

Summary

name()

Name to identify an Admin instance.

option()

t()

fetch!(name)

Returns the Beacon.LiveAdmin.Config for instance name.

new(opts)

Build a new %Beacon.LiveAdmin.Config{} to hold the entire configuration for each Admin instance.

@type name() :: atom()

Name to identify an Admin instance.

@type option() :: {:name, name()}

@type t() :: %Beacon.LiveAdmin.Config{name: name()}

@spec fetch!(name()) :: t()

Returns the Beacon.LiveAdmin.Config for instance name.

@spec new([option()]) :: t()

Build a new %Beacon.LiveAdmin.Config{} to hold the entire configuration for each Admin instance.

:site - name/0 (required). Name of the Admin instance, must be unique. Defaults to :admin.

iex> Beacon.LiveAdmin.Config.new(
  name: :my_admin
)
%Beacon.LiveAdmin.Config{
  name: :my_admin
}