HumanReadableIdentifierGenerator (human_readable_identifier_generator v1.0.0)

Present ID's to humans that are readable and writeable.

Link to this section Summary

Functions

Generate Human Readable ID from id

Generate Human Readable ID from id

Link to this section Functions

Link to this function

fetch_human_readable_id(id, server \\ Storage)

Specs

fetch_human_readable_id(id :: String.t(), server :: Agent.agent()) ::
  {:ok, String.t()} | :error

Generate Human Readable ID from id

Examples

iex> HumanReadableIdentifierGenerator.fetch_human_readable_id("557b72bf-faa8-4e19-9d8b-ee86efbaeeb6")
{:ok, "civi-parvas-28"}
Link to this function

fetch_human_readable_id!(id, server \\ Storage)

Specs

fetch_human_readable_id!(id :: String.t(), server :: Agent.agent()) ::
  String.t()

Generate Human Readable ID from id

Examples

iex> HumanReadableIdentifierGenerator.fetch_human_readable_id!("557b72bf-faa8-4e19-9d8b-ee86efbaeeb6")
"civi-parvas-28"