Monetized v0.5.0 Monetized.Currency

Defines available currencies and functions to handle them.

Summary

Functions

all()

Retrieves a struct holding all the currency options

get(key)

Retrieves the currency struct for the given key

keys()

Retrieves a list of currency options keys

parse(str)

Attempts to parse the currency from the given string based on both the currency key and the symbol

parse_by_key(str)

Attempts to parse the currency from the given string based on the currency key

parse_by_symbol(arg1)

Attempts to guess the currency from the given string based on the currency symbol

Functions

all()

Specs

all :: %{optional(bitstring) => %{name: bitstring, symbol: bitstring, key: bitstring}}

Retrieves a struct holding all the currency options.

get(key)

Specs

get(String.t) :: struct

Retrieves the currency struct for the given key.

Examples

iex> Monetized.Currency.get("EUR")
%{name: "Euro", symbol: "€", key: "EUR"}

iex> Monetized.Currency.get("THB")
%{name: "Thai Baht", symbol: "฿", key: "THB"}

iex> Monetized.Currency.get("PHP")
%{key: "PHP", name: "Philippine Peso", symbol: "₱"}

keys()

Specs

keys :: list

Retrieves a list of currency options keys

parse(str)

Attempts to parse the currency from the given string based on both the currency key and the symbol.

Examples

iex> Monetized.Currency.parse("EUR 200.00")
%{name: "Euro", symbol: "€", key: "EUR"}

iex> Monetized.Currency.parse("£ 200.00")
%{name: "Pound Sterling", symbol: "£", key: "GBP"}

iex> Monetized.Currency.parse("200.00 USD")
%{name: "US Dollar", symbol: "$", key: "USD"}

iex> Monetized.Currency.parse("200.00 THB")
%{name: "Thai Baht", symbol: "฿", key: "THB"}

iex> Monetized.Currency.parse("200.00 PHP")
%{key: "PHP", name: "Philippine Peso", symbol: "₱"}

parse_by_key(str)

Attempts to parse the currency from the given string based on the currency key.

Examples

iex> Monetized.Currency.parse_by_key("EUR 200.00")
%{name: "Euro", symbol: "€", key: "EUR"}

iex> Monetized.Currency.parse_by_key("200.00 USD")
%{name: "US Dollar", symbol: "$", key: "USD"}

iex> Monetized.Currency.parse_by_key("200.00 GBP")
%{name: "Pound Sterling", symbol: "£", key: "GBP"}

iex> Monetized.Currency.parse_by_key("200.00 THB")
%{name: "Thai Baht", symbol: "฿", key: "THB"}

iex> Monetized.Currency.parse_by_key("200.00 PHP")
%{key: "PHP", name: "Philippine Peso", symbol: "₱"}

iex> Monetized.Currency.parse_by_key("200.00 ARS")
%{key: "ARS", name: "Argentinian Peso", symbol: "A$"}

parse_by_symbol(arg1)

Attempts to guess the currency from the given string based on the currency symbol.

Examples

iex> Monetized.Currency.parse_by_symbol("€ 200.00")
%{name: "Euro", symbol: "€", key: "EUR"}

iex> Monetized.Currency.parse_by_symbol("$200.00")
%{name: "US Dollar", symbol: "$", key: "USD"}

iex> Monetized.Currency.parse_by_symbol("£200.00")
%{name: "Pound Sterling", symbol: "£", key: "GBP"}

iex> Monetized.Currency.parse_by_symbol("฿200.00")
%{name: "Thai Baht", symbol: "฿", key: "THB"}

iex> Monetized.Currency.parse_by_symbol("₱200.00")
%{key: "PHP", name: "Philippine Peso", symbol: "₱"}