# `Unicode.LineBreak`
[🔗](https://github.com/elixir-unicode/unicode/blob/v1.21.1/lib/unicode/property/line_break.ex#L1)

Functions to introspect Unicode
line breaks for binaries
(Strings) and codepoints.

# `aliases`

Returns a map of aliases for
Unicode line breaks.

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

# `count`

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

## Example

    iex> Unicode.LineBreak.count(:al)
    26954

# `fetch`

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

Aliases are resolved by this function.

Returns either `{:ok, range_list}` or
`:error`.

# `get`

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

Aliases are resolved by this function.

Returns either `range_list` or
`nil`.

# `known_line_breaks`

Returns a list of known Unicode
line break names.

This function does not return the
names of any line break aliases.

# `line_break`

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

In the case of a codepoint, a single
line_break name is returned.

For a binary a list of distinct line break
names represented by the lines in
the binary is returned.

# `line_breaks`

Returns the map of Unicode
line breaks.

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*