@spec check(map() | String.t()) :: boolean()

Shortcut for LangTags.Tag.valid?/1. Returns true if the tag is valid, false otherwise.

For meaningful error output see errors/1.

@spec date() :: String.t()

Returns the file date for the underlying data, as a string.

Examples

iex> LangTags.date() |> String.match?(~r/\d{4}-\d{2}-\d{2}/)
true

@spec filter(String.t() | [String.t()]) :: [String.t()]

The opposite of subtags/1. Returns a list of codes that are not registered subtags, otherwise returns an empty array.

Examples

iex> LangTags.filter(["en", "Aargh"])
["Aargh"]

@spec language(String.t()) :: map() | nil

Convenience method to get a single language type subtag. Returns a subtag map or nil.

Examples

iex> LangTags.language("en")
%{"Record" => %{"Added" => "2005-10-16", "Description" => ["English"],
    "Subtag" => "en", "Suppress-Script" => "Latn", "Type" => "language"},
  "Subtag" => "en"}
iex> LangTags.language("us")
nil

@spec languages(String.t()) :: [map()] | Exception.t()

Returns a list of subtag maps representing all the language type subtags belonging to the given macrolanguage type subtag.

Throws an error if macrolanguage is not a macrolanguage.

Examples

iex> LangTags.languages("zh") |> Enum.count()
38
iex> LangTags.languages("en")
** (ArgumentError) 'en' is not a valid macrolanguage.

@spec region(String.t()) :: map() | nil

As language/1, but with region type subtags.

Examples

iex> LangTags.region("mt")
%{"Record" => %{"Added" => "2005-10-16", "Description" => ["Malta"],
    "Subtag" => "mt", "Type" => "region"}, "Subtag" => "mt"}
iex> LangTags.region("en")
nil

@spec script(String.t()) :: map() | nil

As language/1, but with script type subtags.

Examples

iex> LangTags.script("aghb")
%{"Record" => %{"Added" => "2012-11-01",
    "Description" => ["Caucasian Albanian"], "Subtag" => "aghb",
    "Type" => "script"}, "Subtag" => "aghb"}
iex> LangTags.script("en")
nil

@spec search(String.t() | Regex.t(), boolean()) :: [map()]

Search for tags and subtags by description.

Supports either a Regex or a string for description. Returns a list of subtag and tag maps, or an empty list if no results were found.

Search is case-insensitive when description is a string, and matches on any part of a description. Entries whose description matches the query exactly are returned first; the rest follow in registry order.

Note that tag maps in the results represent grandfathered or redundant tags. These are excluded by default. Set the all parameter to true to include them.

Examples

iex> LangTags.search("Maltese") |> Enum.map(&LangTags.SubTag.format/1)
["mt", "mdl", "mdl"]

iex> LangTags.search(~r/^Klingon$/) |> Enum.map(&LangTags.SubTag.format/1)
["tlh"]

iex> LangTags.search("Gibberish")
[]

@spec subtags(String.t() | [String.t()]) :: [map()]

Look up one or more subtags. Returns a list of subtag maps. Returns an empty list if all of the subtags are non-existent.

Examples

Calling LangTags.subtags("mt") will return an array with 2 subtag maps: one for Malta (the 'region' type subtag) and one for Maltese (the 'language' type subtag).

iex> for subtag <- LangTags.subtags("mt"), do: subtag["Record"]["Description"]
[["Maltese"], ["Malta"]]
iex> LangTags.subtags(["mt", "ca"]) |> Enum.count()
4
iex> LangTags.subtags("bumblebee")
[]

To get or check a single subtag by type use language/1, region/1 or type/2.

@spec tags(String.t()) :: map()

Shortcut for LangTags.Tag.new/1

Examples

iex> LangTags.tags("art-lojban") == LangTags.Tag.new("art-lojban")
true

@spec type(String.t(), String.t()) :: map() | nil

Get a subtag by type. Returns the subtag matching type as a subtag map otherwise returns nil.

A type consists of one of the following strings: language, extlang, script, region or variant. To get a grandfathered or redundant type tag use tags/1.

Examples

iex> LangTags.type("zh", "language") == LangTags.language("zh")
true
iex> LangTags.type("zh", "script")
nil

Look up for one or more types for the given string.

Returns an empty list if the does not have any type or if the available types are: grandfathered or redundant.

By default, the types grandfathered or redundant are excluded from the result. Set the all parameter to true to include them.

Examples

iex> LangTags.types("en")
["language"]
iex> LangTags.types("xml")
["extlang", "language"]
iex> LangTags.types("art-lojban")
[]
iex> LangTags.types("art-lojban", true)
["grandfathered"]