Iuliia.Schema (iuliia v0.1.1) View Source

Schema provides methods to work with available transliteration schemas.

Link to this section Summary

Functions

Returns all available schemas names

Lookup for schema by schema name and returns schema data. Raises ArgumentError if there is no such schema or schema can not be parsed.

Link to this section Functions

Specs

available_schemas() :: [map()]

Returns all available schemas names

Example

iex> Iuliia.Schema.available_schemas()

["ala_lc", "ala_lc_alt", "bgn_pcgn", "bgn_pcgn_alt", "bs_2979", "bs_2979_alt",
"gost_16876", "gost_16876_alt", "gost_52290", "gost_52535", "gost_7034",
"gost_779", "gost_779_alt", "icao_doc_9303", "iso_9_1954", "iso_9_1968",
"iso_9_1968_alt", "mosmetro", "mvd_310", "mvd_310_fr", "mvd_782", "scientific",
"telegram", "ungegn_1987", "wikipedia", "yandex_maps", "yandex_money"]

Specs

lookup(String.t()) :: map()

Lookup for schema by schema name and returns schema data. Raises ArgumentError if there is no such schema or schema can not be parsed.

Example

iex> Iuliia.Schema.lookup("wikipedia")

%{
  "description" => "Wikipedia transliteration schema",
  "ending_mapping" => %{"ий" => "y", "ый" => "y"},
  ...
}