Returns a map of aliases for Unicode properties.

An alias is an alternative name for referring to a property. Aliases are resolved by the fetch/1 and get/1 functions.

Returns

• A map of property aliases to property names.

Examples

iex> Unicode.Property.aliases() |> Map.get("alpha")
:alphabetic

Returns :alphabetic or nil indicating if the codepoint or string has the property :alphabetic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :alphabetic or nil. For a string, the result is :alphabetic only if all codepoints in the string have the :alphabetic property.

Returns a boolean indicating if the codepoint or string has the property :alphabetic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :alphabetic property.

Returns :alphanumeric or nil based upon whether the given codepoint or binary is all alphanumeric characters.

This is useful when the desired result is truthy or falsy.

Arguments

• codepoint_or_binary is a single integer codepoint or a String.t/0.

Returns

• :alphanumeric or

• nil.

Examples

iex> Unicode.Property.alphanumeric "123abc"
:alphanumeric

iex> Unicode.Property.alphanumeric "???"
nil

Returns a boolean based upon whether the given codepoint or binary is all alphanumeric characters.

Arguments

• codepoint_or_binary is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string are alphanumeric.

Examples

iex> Unicode.Property.alphanumeric? "123abc"
true

iex> Unicode.Property.alphanumeric? "⅔"
false

Returns :ascii_hex_digit or nil indicating if the codepoint or string has the property :ascii_hex_digit.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :ascii_hex_digit or nil. For a string, the result is :ascii_hex_digit only if all codepoints in the string have the :ascii_hex_digit property.

Returns a boolean indicating if the codepoint or string has the property :ascii_hex_digit.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :ascii_hex_digit property.

Returns :bidi_control or nil indicating if the codepoint or string has the property :bidi_control.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :bidi_control or nil. For a string, the result is :bidi_control only if all codepoints in the string have the :bidi_control property.

Returns a boolean indicating if the codepoint or string has the property :bidi_control.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :bidi_control property.

Returns :case_ignorable or nil indicating if the codepoint or string has the property :case_ignorable.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :case_ignorable or nil. For a string, the result is :case_ignorable only if all codepoints in the string have the :case_ignorable property.

Returns a boolean indicating if the codepoint or string has the property :case_ignorable.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :case_ignorable property.

Returns :cased or nil indicating if the codepoint or string has the property :cased.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :cased or nil. For a string, the result is :cased only if all codepoints in the string have the :cased property.

Returns a boolean indicating if the codepoint or string has the property :cased.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :cased property.

Returns :changes_when_casefolded or nil indicating if the codepoint or string has the property :changes_when_casefolded.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :changes_when_casefolded or nil. For a string, the result is :changes_when_casefolded only if all codepoints in the string have the :changes_when_casefolded property.

Returns a boolean indicating if the codepoint or string has the property :changes_when_casefolded.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :changes_when_casefolded property.

Returns :changes_when_casemapped or nil indicating if the codepoint or string has the property :changes_when_casemapped.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :changes_when_casemapped or nil. For a string, the result is :changes_when_casemapped only if all codepoints in the string have the :changes_when_casemapped property.

Returns a boolean indicating if the codepoint or string has the property :changes_when_casemapped.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :changes_when_casemapped property.

Returns :changes_when_lowercased or nil indicating if the codepoint or string has the property :changes_when_lowercased.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :changes_when_lowercased or nil. For a string, the result is :changes_when_lowercased only if all codepoints in the string have the :changes_when_lowercased property.

Returns a boolean indicating if the codepoint or string has the property :changes_when_lowercased.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :changes_when_lowercased property.

Returns :changes_when_titlecased or nil indicating if the codepoint or string has the property :changes_when_titlecased.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :changes_when_titlecased or nil. For a string, the result is :changes_when_titlecased only if all codepoints in the string have the :changes_when_titlecased property.

Returns a boolean indicating if the codepoint or string has the property :changes_when_titlecased.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :changes_when_titlecased property.

Returns :changes_when_uppercased or nil indicating if the codepoint or string has the property :changes_when_uppercased.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :changes_when_uppercased or nil. For a string, the result is :changes_when_uppercased only if all codepoints in the string have the :changes_when_uppercased property.

Returns a boolean indicating if the codepoint or string has the property :changes_when_uppercased.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :changes_when_uppercased property.

Returns the count of the number of characters for a given property.

Arguments

• property is a property name as an atom.

Returns

• The number of codepoints that have the given property.

Examples

iex> Unicode.Property.count(:lowercase)
2595

Returns :dash or nil indicating if the codepoint or string has the property :dash.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :dash or nil. For a string, the result is :dash only if all codepoints in the string have the :dash property.

Returns a boolean indicating if the codepoint or string has the property :dash.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :dash property.

Returns :default_ignorable_code_point or nil indicating if the codepoint or string has the property :default_ignorable_code_point.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :default_ignorable_code_point or nil. For a string, the result is :default_ignorable_code_point only if all codepoints in the string have the :default_ignorable_code_point property.

Returns a boolean indicating if the codepoint or string has the property :default_ignorable_code_point.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :default_ignorable_code_point property.

Returns :deprecated or nil indicating if the codepoint or string has the property :deprecated.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :deprecated or nil. For a string, the result is :deprecated only if all codepoints in the string have the :deprecated property.

Returns a boolean indicating if the codepoint or string has the property :deprecated.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :deprecated property.

Returns :diacritic or nil indicating if the codepoint or string has the property :diacritic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :diacritic or nil. For a string, the result is :diacritic only if all codepoints in the string have the :diacritic property.

Returns a boolean indicating if the codepoint or string has the property :diacritic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :diacritic property.

Returns :emoji or nil indicating if the codepoint or string has the property :emoji.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :emoji or nil. For a string, the result is :emoji only if all codepoints in the string have the :emoji property.

Returns a boolean indicating if the codepoint or string has the property :emoji.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :emoji property.

Returns :emoji_component or nil indicating if the codepoint or string has the property :emoji_component.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :emoji_component or nil. For a string, the result is :emoji_component only if all codepoints in the string have the :emoji_component property.

Returns a boolean indicating if the codepoint or string has the property :emoji_component.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :emoji_component property.

Returns :emoji_modifier or nil indicating if the codepoint or string has the property :emoji_modifier.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :emoji_modifier or nil. For a string, the result is :emoji_modifier only if all codepoints in the string have the :emoji_modifier property.

Returns a boolean indicating if the codepoint or string has the property :emoji_modifier.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :emoji_modifier property.

Returns :emoji_modifier_base or nil indicating if the codepoint or string has the property :emoji_modifier_base.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :emoji_modifier_base or nil. For a string, the result is :emoji_modifier_base only if all codepoints in the string have the :emoji_modifier_base property.

Returns a boolean indicating if the codepoint or string has the property :emoji_modifier_base.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :emoji_modifier_base property.

Returns :emoji_presentation or nil indicating if the codepoint or string has the property :emoji_presentation.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :emoji_presentation or nil. For a string, the result is :emoji_presentation only if all codepoints in the string have the :emoji_presentation property.

Returns a boolean indicating if the codepoint or string has the property :emoji_presentation.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :emoji_presentation property.

Returns :extended_numeric or nil based upon whether the given codepoint or binary is all extended numeric characters.

Extended numeric includes fractions, superscripts, subscripts and other characters in the category No.

This is useful when the desired result is truthy or falsy.

Arguments

• codepoint_or_binary is a single integer codepoint or a String.t/0.

Returns

• :extended_numeric or

• nil.

Examples

iex> Unicode.Property.extended_numeric "123"
:extended_numeric

iex> Unicode.Property.extended_numeric "⅔"
:extended_numeric

iex> Unicode.Property.extended_numeric "-123"
nil

Returns a boolean based upon whether the given codepoint or binary is all extended numeric characters.

Extended numeric includes fractions, superscripts, subscripts and other characters in the category No.

Arguments

• codepoint_or_binary is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string are extended numeric.

Examples

iex> Unicode.Property.extended_numeric? "123"
true

iex> Unicode.Property.extended_numeric? "⅔"
true

Returns :extended_pictographic or nil indicating if the codepoint or string has the property :extended_pictographic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :extended_pictographic or nil. For a string, the result is :extended_pictographic only if all codepoints in the string have the :extended_pictographic property.

Returns a boolean indicating if the codepoint or string has the property :extended_pictographic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :extended_pictographic property.

Returns :extender or nil indicating if the codepoint or string has the property :extender.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :extender or nil. For a string, the result is :extender only if all codepoints in the string have the :extender property.

Returns a boolean indicating if the codepoint or string has the property :extender.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :extender property.

Returns the Unicode ranges for a given property as a list of ranges as 2-tuples.

Aliases are resolved by this function.

Arguments

• property is a property name as a string or atom.

Returns

• {:ok, range_list} or

• :error if the property is not known.

Examples

iex> {:ok, ranges} = Unicode.Property.fetch(:alphabetic)
iex> Enum.take(ranges, 2)
[{65, 90}, {97, 122}]

iex> Unicode.Property.fetch(:not_a_property)
:error

Returns the Unicode ranges for a given property as a list of ranges as 2-tuples.

Aliases are resolved by this function.

Arguments

• property is a property name as a string or atom.

Returns

• range_list or

• nil if the property is not known.

Examples

iex> Unicode.Property.get(:alphabetic) |> Enum.take(2)
[{65, 90}, {97, 122}]

iex> Unicode.Property.get(:not_a_property)
nil

Returns :grapheme_base or nil indicating if the codepoint or string has the property :grapheme_base.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :grapheme_base or nil. For a string, the result is :grapheme_base only if all codepoints in the string have the :grapheme_base property.

Returns a boolean indicating if the codepoint or string has the property :grapheme_base.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :grapheme_base property.

Returns :grapheme_extend or nil indicating if the codepoint or string has the property :grapheme_extend.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :grapheme_extend or nil. For a string, the result is :grapheme_extend only if all codepoints in the string have the :grapheme_extend property.

Returns a boolean indicating if the codepoint or string has the property :grapheme_extend.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :grapheme_extend property.

Returns :grapheme_link or nil indicating if the codepoint or string has the property :grapheme_link.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :grapheme_link or nil. For a string, the result is :grapheme_link only if all codepoints in the string have the :grapheme_link property.

Returns a boolean indicating if the codepoint or string has the property :grapheme_link.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :grapheme_link property.

Returns :hex_digit or nil indicating if the codepoint or string has the property :hex_digit.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :hex_digit or nil. For a string, the result is :hex_digit only if all codepoints in the string have the :hex_digit property.

Returns a boolean indicating if the codepoint or string has the property :hex_digit.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :hex_digit property.

Returns :hyphen or nil indicating if the codepoint or string has the property :hyphen.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :hyphen or nil. For a string, the result is :hyphen only if all codepoints in the string have the :hyphen property.

Returns a boolean indicating if the codepoint or string has the property :hyphen.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :hyphen property.

Returns :id_compat_math_continue or nil indicating if the codepoint or string has the property :id_compat_math_continue.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :id_compat_math_continue or nil. For a string, the result is :id_compat_math_continue only if all codepoints in the string have the :id_compat_math_continue property.

Returns a boolean indicating if the codepoint or string has the property :id_compat_math_continue.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :id_compat_math_continue property.

Returns :id_compat_math_start or nil indicating if the codepoint or string has the property :id_compat_math_start.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :id_compat_math_start or nil. For a string, the result is :id_compat_math_start only if all codepoints in the string have the :id_compat_math_start property.

Returns a boolean indicating if the codepoint or string has the property :id_compat_math_start.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :id_compat_math_start property.

Returns :id_continue or nil indicating if the codepoint or string has the property :id_continue.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :id_continue or nil. For a string, the result is :id_continue only if all codepoints in the string have the :id_continue property.

Returns a boolean indicating if the codepoint or string has the property :id_continue.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :id_continue property.

Returns :id_start or nil indicating if the codepoint or string has the property :id_start.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :id_start or nil. For a string, the result is :id_start only if all codepoints in the string have the :id_start property.

Returns a boolean indicating if the codepoint or string has the property :id_start.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :id_start property.

Returns :ideographic or nil indicating if the codepoint or string has the property :ideographic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :ideographic or nil. For a string, the result is :ideographic only if all codepoints in the string have the :ideographic property.

Returns a boolean indicating if the codepoint or string has the property :ideographic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :ideographic property.

Returns :ids_binary_operator or nil indicating if the codepoint or string has the property :ids_binary_operator.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :ids_binary_operator or nil. For a string, the result is :ids_binary_operator only if all codepoints in the string have the :ids_binary_operator property.

Returns a boolean indicating if the codepoint or string has the property :ids_binary_operator.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :ids_binary_operator property.

Returns :ids_trinary_operator or nil indicating if the codepoint or string has the property :ids_trinary_operator.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :ids_trinary_operator or nil. For a string, the result is :ids_trinary_operator only if all codepoints in the string have the :ids_trinary_operator property.

Returns a boolean indicating if the codepoint or string has the property :ids_trinary_operator.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :ids_trinary_operator property.

Returns :ids_unary_operator or nil indicating if the codepoint or string has the property :ids_unary_operator.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :ids_unary_operator or nil. For a string, the result is :ids_unary_operator only if all codepoints in the string have the :ids_unary_operator property.

Returns a boolean indicating if the codepoint or string has the property :ids_unary_operator.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :ids_unary_operator property.

Returns :incb or nil indicating if the codepoint or string has the property :incb.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :incb or nil. For a string, the result is :incb only if all codepoints in the string have the :incb property.

Returns a boolean indicating if the codepoint or string has the property :incb.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :incb property.

Returns :join_control or nil indicating if the codepoint or string has the property :join_control.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :join_control or nil. For a string, the result is :join_control only if all codepoints in the string have the :join_control property.

Returns a boolean indicating if the codepoint or string has the property :join_control.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :join_control property.

Returns a list of known Unicode property names.

This function does not return the names of any property aliases.

Returns

• A list of atom property names.

Examples

iex> :alphabetic in Unicode.Property.known_properties()
true

Returns :logical_order_exception or nil indicating if the codepoint or string has the property :logical_order_exception.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :logical_order_exception or nil. For a string, the result is :logical_order_exception only if all codepoints in the string have the :logical_order_exception property.

Returns a boolean indicating if the codepoint or string has the property :logical_order_exception.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :logical_order_exception property.

Returns :lowercase or nil indicating if the codepoint or string has the property :lowercase.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :lowercase or nil. For a string, the result is :lowercase only if all codepoints in the string have the :lowercase property.

Returns a boolean indicating if the codepoint or string has the property :lowercase.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :lowercase property.

Returns :math or nil indicating if the codepoint or string has the property :math.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :math or nil. For a string, the result is :math only if all codepoints in the string have the :math property.

Returns a boolean indicating if the codepoint or string has the property :math.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :math property.

Returns :modifier_combining_mark or nil indicating if the codepoint or string has the property :modifier_combining_mark.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :modifier_combining_mark or nil. For a string, the result is :modifier_combining_mark only if all codepoints in the string have the :modifier_combining_mark property.

Returns a boolean indicating if the codepoint or string has the property :modifier_combining_mark.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :modifier_combining_mark property.

Returns :noncharacter_code_point or nil indicating if the codepoint or string has the property :noncharacter_code_point.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :noncharacter_code_point or nil. For a string, the result is :noncharacter_code_point only if all codepoints in the string have the :noncharacter_code_point property.

Returns a boolean indicating if the codepoint or string has the property :noncharacter_code_point.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :noncharacter_code_point property.

Returns :numeric or nil based upon whether the given codepoint or binary is all numeric characters.

This is useful when the desired result is truthy or falsy.

Arguments

• codepoint_or_binary is a single integer codepoint or a String.t/0.

Returns

• :numeric or

• nil.

Examples

iex> Unicode.Property.numeric "123"
:numeric

iex> Unicode.Property.numeric "123a"
nil

Returns a boolean based upon whether the given codepoint or binary is all numeric characters.

Arguments

• codepoint_or_binary is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string are numeric.

Examples

iex> Unicode.Property.numeric? "123"
true

iex> Unicode.Property.numeric? "123a"
false

Returns :other_alphabetic or nil indicating if the codepoint or string has the property :other_alphabetic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :other_alphabetic or nil. For a string, the result is :other_alphabetic only if all codepoints in the string have the :other_alphabetic property.

Returns a boolean indicating if the codepoint or string has the property :other_alphabetic.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :other_alphabetic property.

Returns :other_default_ignorable_code_point or nil indicating if the codepoint or string has the property :other_default_ignorable_code_point.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :other_default_ignorable_code_point or nil. For a string, the result is :other_default_ignorable_code_point only if all codepoints in the string have the :other_default_ignorable_code_point property.

Returns a boolean indicating if the codepoint or string has the property :other_default_ignorable_code_point.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :other_default_ignorable_code_point property.

Returns :other_grapheme_extend or nil indicating if the codepoint or string has the property :other_grapheme_extend.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :other_grapheme_extend or nil. For a string, the result is :other_grapheme_extend only if all codepoints in the string have the :other_grapheme_extend property.

Returns a boolean indicating if the codepoint or string has the property :other_grapheme_extend.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :other_grapheme_extend property.

Returns :other_id_continue or nil indicating if the codepoint or string has the property :other_id_continue.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :other_id_continue or nil. For a string, the result is :other_id_continue only if all codepoints in the string have the :other_id_continue property.

Returns a boolean indicating if the codepoint or string has the property :other_id_continue.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :other_id_continue property.

Returns :other_id_start or nil indicating if the codepoint or string has the property :other_id_start.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :other_id_start or nil. For a string, the result is :other_id_start only if all codepoints in the string have the :other_id_start property.

Returns a boolean indicating if the codepoint or string has the property :other_id_start.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :other_id_start property.

Returns :other_lowercase or nil indicating if the codepoint or string has the property :other_lowercase.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :other_lowercase or nil. For a string, the result is :other_lowercase only if all codepoints in the string have the :other_lowercase property.

Returns a boolean indicating if the codepoint or string has the property :other_lowercase.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :other_lowercase property.

Returns :other_math or nil indicating if the codepoint or string has the property :other_math.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :other_math or nil. For a string, the result is :other_math only if all codepoints in the string have the :other_math property.

Returns a boolean indicating if the codepoint or string has the property :other_math.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :other_math property.

Returns :other_uppercase or nil indicating if the codepoint or string has the property :other_uppercase.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :other_uppercase or nil. For a string, the result is :other_uppercase only if all codepoints in the string have the :other_uppercase property.

Returns a boolean indicating if the codepoint or string has the property :other_uppercase.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :other_uppercase property.

Returns :pattern_syntax or nil indicating if the codepoint or string has the property :pattern_syntax.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :pattern_syntax or nil. For a string, the result is :pattern_syntax only if all codepoints in the string have the :pattern_syntax property.

Returns a boolean indicating if the codepoint or string has the property :pattern_syntax.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :pattern_syntax property.

Returns :pattern_white_space or nil indicating if the codepoint or string has the property :pattern_white_space.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :pattern_white_space or nil. For a string, the result is :pattern_white_space only if all codepoints in the string have the :pattern_white_space property.

Returns a boolean indicating if the codepoint or string has the property :pattern_white_space.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :pattern_white_space property.

Returns :prepended_concatenation_mark or nil indicating if the codepoint or string has the property :prepended_concatenation_mark.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :prepended_concatenation_mark or nil. For a string, the result is :prepended_concatenation_mark only if all codepoints in the string have the :prepended_concatenation_mark property.

Returns a boolean indicating if the codepoint or string has the property :prepended_concatenation_mark.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :prepended_concatenation_mark property.

Returns the map of Unicode properties.

The property name is the map key and a list of codepoint ranges as tuples as the value.

Returns

• A map of property names to a list of codepoint ranges.

Examples

iex> Unicode.Property.properties() |> Map.get(:alphabetic) |> Enum.take(2)
[{65, 90}, {97, 122}]

@spec properties(string_or_codepoint()) :: [atom(), ...] | [[atom(), ...], ...]

Returns the property name(s) for the given binary or codepoint.

Arguments

• codepoint is a single integer codepoint or a String.t/0.

Returns

• In the case of a codepoint, a single list of the properties of that codepoint.

• In the case of a binary, a list of property lists, one for each codepoint in the binary.

Examples

iex> Unicode.Property.properties(?A)
[
  :alphabetic,
  :ascii_hex_digit,
  :cased,
  :changes_when_casefolded,
  :changes_when_casemapped,
  :changes_when_lowercased,
  :grapheme_base,
  :hex_digit,
  :id_continue,
  :id_start,
  :uppercase,
  :xid_continue,
  :xid_start
]

Returns :quotation_mark or nil indicating if the codepoint or string has the property :quotation_mark.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :quotation_mark or nil. For a string, the result is :quotation_mark only if all codepoints in the string have the :quotation_mark property.

Returns a boolean indicating if the codepoint or string has the property :quotation_mark.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :quotation_mark property.

Returns :radical or nil indicating if the codepoint or string has the property :radical.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :radical or nil. For a string, the result is :radical only if all codepoints in the string have the :radical property.

Returns a boolean indicating if the codepoint or string has the property :radical.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :radical property.

Returns :regional_indicator or nil indicating if the codepoint or string has the property :regional_indicator.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :regional_indicator or nil. For a string, the result is :regional_indicator only if all codepoints in the string have the :regional_indicator property.

Returns a boolean indicating if the codepoint or string has the property :regional_indicator.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :regional_indicator property.

Returns :sentence_terminal or nil indicating if the codepoint or string has the property :sentence_terminal.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :sentence_terminal or nil. For a string, the result is :sentence_terminal only if all codepoints in the string have the :sentence_terminal property.

Returns a boolean indicating if the codepoint or string has the property :sentence_terminal.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :sentence_terminal property.

Returns a map of properties to the module that serves that property.

Returns

• A map of property names to the module that serves that property.

Examples

iex> Unicode.Property.servers() |> Map.get("script")
Unicode.Script

Returns :soft_dotted or nil indicating if the codepoint or string has the property :soft_dotted.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :soft_dotted or nil. For a string, the result is :soft_dotted only if all codepoints in the string have the :soft_dotted property.

Returns a boolean indicating if the codepoint or string has the property :soft_dotted.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :soft_dotted property.

Returns :terminal_punctuation or nil indicating if the codepoint or string has the property :terminal_punctuation.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :terminal_punctuation or nil. For a string, the result is :terminal_punctuation only if all codepoints in the string have the :terminal_punctuation property.

Returns a boolean indicating if the codepoint or string has the property :terminal_punctuation.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :terminal_punctuation property.

Returns :unified_ideograph or nil indicating if the codepoint or string has the property :unified_ideograph.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :unified_ideograph or nil. For a string, the result is :unified_ideograph only if all codepoints in the string have the :unified_ideograph property.

Returns a boolean indicating if the codepoint or string has the property :unified_ideograph.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :unified_ideograph property.

Returns :uppercase or nil indicating if the codepoint or string has the property :uppercase.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :uppercase or nil. For a string, the result is :uppercase only if all codepoints in the string have the :uppercase property.

Returns a boolean indicating if the codepoint or string has the property :uppercase.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :uppercase property.

Returns :variation_selector or nil indicating if the codepoint or string has the property :variation_selector.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :variation_selector or nil. For a string, the result is :variation_selector only if all codepoints in the string have the :variation_selector property.

Returns a boolean indicating if the codepoint or string has the property :variation_selector.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :variation_selector property.

Returns :white_space or nil indicating if the codepoint or string has the property :white_space.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :white_space or nil. For a string, the result is :white_space only if all codepoints in the string have the :white_space property.

Returns a boolean indicating if the codepoint or string has the property :white_space.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :white_space property.

Returns :xid_continue or nil indicating if the codepoint or string has the property :xid_continue.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :xid_continue or nil. For a string, the result is :xid_continue only if all codepoints in the string have the :xid_continue property.

Returns a boolean indicating if the codepoint or string has the property :xid_continue.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :xid_continue property.

Returns :xid_start or nil indicating if the codepoint or string has the property :xid_start.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• :xid_start or nil. For a string, the result is :xid_start only if all codepoints in the string have the :xid_start property.

Returns a boolean indicating if the codepoint or string has the property :xid_start.

Arguments

• codepoint_or_string is a single integer codepoint or a String.t/0.

Returns

• true or false. For a string, the result is true only if all codepoints in the string have the :xid_start property.