ordinal v0.1.0 Ordinal View Source

Documentation for Ordinal.

Link to this section Summary

Functions

Converts positive integers to their ordinalized string equivalents

Link to this section Functions

Link to this function ordinalize(number) View Source
ordinalize(integer()) :: String.t()

Converts positive integers to their ordinalized string equivalents.

Examples

iex> Ordinal.ordinalize(1)
"1st"

iex> Ordinal.ordinalize(11)
"11th"

iex> Ordinal.ordinalize(111)
"111th"

iex> Ordinal.ordinalize(0)
"0th"

## Invalid Examples

iex> Ordinal.ordinalize(1.1)
1.1

iex> Ordinal.ordinalize(-1)
-1

iex> Ordinal.ordinalize("apple")
"apple"