View Source Magma.Config (Magma v0.2.0)

Cache for the vault-based configuration.

This singleton GenServer provides access to the cached Magma.Config.Documents in the Magma.Vault.

Summary

Functions

Returns a Magma.Config.Artefact document or a property of it.

Returns the path with Magma.Config.Artefact documents in the vault.

Constructs a complete path to a artefact config document by joining the specified segments to the artefacts_path/0.

Returns a specification to start this module under a supervisor.

Returns a Magma.Config.Matter document or a property of it.

Returns the path with Magma.Config.Matter documents in the vault.

Constructs a complete path to a matter config document by joining the specified segments to the matter_path/0.

Returns the path with Magma.Config.Documents in the vault.

Constructs a complete path to a config document by joining the specified segments to the path/0.

Returns the Magma.Project document or a property of it.

Resets the cache of all documents.

Returns the Magma.Config.System document or a property of it.

Returns the path with templates for the config document for a new vault.

Returns a Magma.Config.TextType document or a property of it.

Returns a list of all text types.

Returns the path with Magma.Config.TextType documents in the vault.

Constructs a complete path to a text type config document by joining the specified segments to the text_types_path/0.

Types

@type t() :: %Magma.Config{
  artefacts: term(),
  matter: term(),
  project: term(),
  system: term(),
  text_types: term()
}

Functions

Link to this function

artefact(type, key \\ nil)

View Source

Returns a Magma.Config.Artefact document or a property of it.

Returns the path with Magma.Config.Artefact documents in the vault.

Link to this function

artefacts_path(segments)

View Source

Constructs a complete path to a artefact config document by joining the specified segments to the artefacts_path/0.

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

matter(type, key \\ nil)

View Source

Returns a Magma.Config.Matter document or a property of it.

Returns the path with Magma.Config.Matter documents in the vault.

Constructs a complete path to a matter config document by joining the specified segments to the matter_path/0.

Returns the path with Magma.Config.Documents in the vault.

Constructs a complete path to a config document by joining the specified segments to the path/0.

Returns the Magma.Project document or a property of it.

Resets the cache of all documents.

@spec start_link(any()) :: GenServer.on_start()

Returns the Magma.Config.System document or a property of it.

Returns the path with templates for the config document for a new vault.

Link to this function

text_type(type, key \\ nil)

View Source

Returns a Magma.Config.TextType document or a property of it.

Returns a list of all text types.

Returns the path with Magma.Config.TextType documents in the vault.

Link to this function

text_types_path(segments)

View Source

Constructs a complete path to a text type config document by joining the specified segments to the text_types_path/0.