luminous v2.6.1

View Source Luminous.Attributes (luminous v2.6.1)

Attributes map variable values (user-defined) to attribute keyword lists. They are created by parsing and validating a NimbleOptions schema (see parse/2).

Link to this section Summary

Types

t()

Functions

parse(opts, schema)

Parse the supplied keyword list using the specified schema (performs validations as well)

parse!(opts, schema)

Parse the supplied keyword list using the specified schema (performs validations as well). Raises on error.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: map()

Link to this section Functions

Link to this function

parse(opts, schema)

View Source 
@spec parse(
  keyword(),
  Luminous.Attributes.Schema.t()
) :: {:ok, t()} | {:error, binary()}

Parse the supplied keyword list using the specified schema (performs validations as well)

Link to this function

parse!(opts, schema)

View Source 
@spec parse!(
  keyword(),
  Luminous.Attributes.Schema.t()
) :: map()

Parse the supplied keyword list using the specified schema (performs validations as well). Raises on error.