Emoshi (Emoshi v0.1.0)
View SourceMain module to query and access emoji data.
See https://www.unicode.org/reports/tr51/ for information about emojis.
Summary
Functions
Returns the closest emojis by slug.
Returns all emojis for the given group
Returns all emojis for the given groups
Returns all emojis for the given group and subgroup(s).
Returns whether an emoji group exists
Returns all the emojis' groups
Returns all Emoshi.t/0
where the slug matches the input argument.
Returns all the subgroups for a group or nil
if the group does not exist
Returns the specs version used to generate the module
Types
Functions
Returns the closest emojis by slug.
Uses String.jaro_distance/2
internally to find the closest emojis.
Options
:ignore_variations
-boolean/0
. Whether to ignore variations such as skin color. Defaults totrue
.:take
-pos_integer/0
. The number of emojis to retrieve. Defaults to5
Returns all emojis for the given group
Returns all emojis for the given groups
Returns all emojis for the given group and subgroup(s).
Accepts both a single subgroup and a list of subgroups
Returns whether an emoji group exists
@spec groups() :: [String.t()]
Returns all the emojis' groups
Returns all Emoshi.t/0
where the slug matches the input argument.
Unlike closest/2
this function checks for substring comparison.
Options
:ignore_variations
-boolean/0
. Whether to ignore variations such as skin color. Defaults totrue
.:take
-pos_integer/0
. The maximum number of emojis to retrieve. Keep in mind that unlikeclosest/2
which always returns the specified:take
number, this function may return fewer results if there are not enough matches. Defaults to5
Returns all the subgroups for a group or nil
if the group does not exist
@spec version() :: String.t()
Returns the specs version used to generate the module