NumberFormatter

Copy Markdown View Source

Build Status Inline docs Coverage Status Module Version Hex Docs Total Download License Last Updated

NumberFormatter is an Elixir library which provides functions to convert numbers into a variety of different formats. Ultimately, it aims to be a partial clone of ActionView::Helpers::NumberHelper from Rails.

NumberFormatter.Currency.number_to_currency(2034.46)
"$2,034.46"

NumberFormatter.Phone.number_to_phone(1112223333, area_code: true, country_code: 1)
"+1 (111) 222-3333"

NumberFormatter.Percentage.number_to_percentage(100, precision: 0)
"100%"

NumberFormatter.Human.number_to_human(1234)
"1.23 Thousand"

NumberFormatter.Delimit.number_to_delimited(12345678)
"12,345,678"

Installation

Get it from Hex:

defp deps do
  [{:number_formatter, "~> 1.0"}]
end

Then run mix deps.get.

Usage

If you want to import all of the functions provided by NumberFormatter, simply use it in your module:

defmodule MyModule do
  use NumberFormatter
end

More likely, you'll want to import the functions you want from one of NumberFormatter's submodules.

defmodule MyModule do
  import NumberFormatter.Currency
end

See the Hex documentation for more information about the modules provided by NumberFormatter.

License

MIT. See LICENSE for more details.